Polis RFID Access System Extended 2

Web API for RFID access system at Paralelni Polis.

Dependencies

• Node.js >= 6.0.0
• Mongo DB
• Git

Setup

Make sure you have the necessary dependencies before continuing.

Get the code:

git clone git@github.com:ParalelniPolis/rfid-access-system-api-2.git

Change into the project directory:

cd rfid-access-system-api-2

Install application dependencies via npm or yarn:

npm install

or

yarn

This will install all node modules that the project requires.

Running the Server

To run the node.js server app:

npm start

Configuration

Configuration variables should be set via environment variables (database credentials, session secret, etc) in .env file - see .env.example.

Tests

If you are working on the server part of the app, then you should run the tests to verify that you haven't broken anything:

npm test

Documentation

You can generate JSDoc documentation automatically by running

npm run jsdoc