feedhenry / users-api

Sample RESTful Users API

Users API

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).

Pre-requisites

To get started, you'll need to have the following requirements installed

• Git
• Node.js¹
• npm
• MongoDB 2.6.x / 3.2.x²

¹See https://nodejs.org/

²See https://docs.mongodb.com/manual/administration/install-community/ for installation guides

Getting started

# 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

Running tests

npm test

API documentation

See API.md for details.

SonarQube

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.