RESTful API implementation, using express and mongodb. Methods for users and articles domain models are exposed. Part of Workast technical assessment.
Prerequisites
A running instance of mongodb is needed. By default a connection to mongodb://localhost:27017 is attempt.
Use Node 6.9.0 or higher, together with NPM 3 or higher.
clone the repository to your local machine and move to project's path:
git clone git@github.com:Franco-Poveda/workast-technical-assessment.git
cd workast-technical-assessmentInstall dependencies via NPM:
npm installalternatively, you can run a full dockerized enviroment, using the provided docker-compose script:
docker-compose build
docker-compose up(you need docker && docker-compose alredy installed on your machine)
To start the service, you need to provide an environment TOKEN_KEY:
TOKEN_KEY="YOUR_TOKEN_KEY" node .The same way IP, PORT and MONGODB_URI can be set, overriding ´config/default.json´ values.
All API endpoints, use Bearer Token authorization, as described on RFC6750.
Just add the header Authorization: Bearer <YOUR_TOKEN_KEY> to all HTTP requests.
Full API documentation, including cURL examples can be found online HERE.
Docs can be generated alongside a markdown, run: npm run docs. I used Apidocjs inline notation for this.
npm test