This sample project will give you a minimal users RESTful API to build your contact list template against. It only implements user listing and reading - feel free to add other actions (e.g. update, delete, create) as you see fit. It is built using JavaScript/Node.js (our language of choice), ExpressJS (a small, lightweight web MVC framework) & Mongoose (a MongoDB object modelling library).
To get started, you'll need to have the following requirements installed
- Git
- Node.js1
- npm
- MongoDB 2.6.x / 3.2.x2
1See https://nodejs.org/
2See https://docs.mongodb.com/manual/administration/install-community/ for installation guides
# Ensure `mongod` is running, either as a service or in another shell
git clone <this repo>
npm install
npm run-script seed # Seed the DB with Users
npm start
npm test
See API.md for details.
In addition to ESLint, we've also included some configuration for SonarQube in sonar-project.properties
.
See http://docs.sonarqube.org/display/SONAR/Get+Started+in+Two+Minutes for more details on how to setup SonarQube locally.