Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 1.21 KB

README.md

File metadata and controls

65 lines (44 loc) · 1.21 KB

VUTTR - Very Useful Tools to Remember

The application is a simple repository for managing tools with their respective names, links, descriptions and tags.

Installation

VUTTR requires Node.js v8+ to run and Mongodb

Install the dependencies and devDependencies and start the server.

$ git clone https://github.com/brunoflegler/api-vuttr.git api-vuttr
$ cd api-vuttr

Installation is done using the npm install command:

$ npm install

Or run Yarn install command:

$ yarn install

Test

To run the test suite, first install the dependencies, then run npm test:

$ npm test

Or run Yarn:

$ yarn test

Run development

Run NPM development:

$ npm run dev

Or run Yarn development:

$ yarn dev

Documentation

Follow our use guide for more information. http://api.myhobbies.com;br.

Using container docker

Deploy Docker requires Docker v18+ and Docker-compose to run.

$ git clone https://github.com/brunoflegler/bossabox.git api-vuttr
$ cd api-vuttr
$ docker-compose up