UK-Recruiment-API

This is an implementation of this code challenge https://github.com/marcusmota/uk-crud-users/Task.md

Documentation

The documentation is available in SwaggerHub / uk-Recruiment-api

API start

The application is built with Node.js and MongoDB as database with docker. To start the application you need docker and docker-compose.

The application will be avaible on PORT 3000 by default.

Note: you should create .env file with the enviroment variables, our docker-compose file already has the NODE_ENV variable, on .env file you just have to copy .env.copy to .env

Running the application in development mode

If you want to run in development mode, use this command

docker-compose -f docker-compose.yml up --build

Running the tests

To run the tests using docker, use this command:

docker-compose -f docker-compose-test.yml up --build

Running the application in production mode

If you want to run in production mode, use this command

docker-compose -f docker-compose-prod.yml up --build

And then you will see something like this on your terminal

Starting ukcrudusers__1 ...
Starting ukcrudusers__1 ... done
Starting ukcrudusers_app_1 ...
Starting ukcrudusers_app_1 ... done

Contributing

Feel free to join us on the API

Authors

• Marcus Mota - MarcusMota