This API is the implementation of the delivery-much test.
Docker and docker-compose
$ docker -v
Docker version 19.03.8, build afacb8b7f0
$ docker-compose -v
docker-compose version 1.25.4, build 8d51620a
Clone the repository and enter the repository directory
$ git clone [email protected]:rafaelcascalho/fun-recipes-api.git
$ cd fun-recipes-api/
You must copy the .env.example into a new file called .env.development and place the required
information.
Once thats done, your .env.development file should look like this:
NODE_ENV=development
PORT=3000
HOST=localhost
GIPHY_API_KEY=your_giphy_api_key_here
After that's done, you can just check if your development environment is running using the command
$ ./run.sh
or
$ sh run.sh
That's it! You're all set. :clinking_beer_mugs:
I've added an api base url to the requests. So, the requests must match
To run the tests just use the command
$ npm test
To check the coverage files use the command
$ npm run cov:serve
- NodeJs - Backend environment for javascript
- Typescript - Typescript as a superset for the node environment
- Ts-node-dev - To restart the node process on file changes
- Express - Express as the http requests handler
- NodeJs - Backend environment for javascript
- Jest - Automated tests library
- Prettier - Code formatter
- Editorconfig - Code style enforcer
- Dotenv - Env files loader
- Eslint - Code linting tool
- Docker - Virtualizer of containers
- Docker Compose - Containers manager