Backend-Controller

a Sails application using Blueprint API

Setup the environment

Sourcing the file env.sh allows will setup environment variable so that starting the application will be possible. It will also setup the $PATH variable so that is will be possible to use the binaries installed with npm for this project.

$ source env.sh

Sails configuration

RESTful routes

In the file config/blueprints.js, the following variables are used to configure the RESTFul routes

actions: false, // disable action routes
rest: true, // REactivate REST routes
shortcuts: false, // the CRUD can only be done through HTTP verbs
pluralize: true // All routes are plural (/users, /tickets ...)

Database configuration

The database configuration is setup in a set of environment variables.

export MONGO_HOST="mongodb"
export MONGO_PORT="27017"
export MONGO_DB="packebian"
export MONGO_USER="packebian"
export MONGO_PASS="packebian123"

These variables are set by sourcing the file env.sh.

Sails secret

The sails secret is a variable that is namely used for sessions. It is setup in an environment variable.

export SAILS_SECRET="c9693b2d5572ffd96a79cae6a8453d57"

This variable is set by sourcing the file env.sh.

auth0

The Packebian app doesn't store password. Auth0 is thus used for authentication in Packebian.

The auth0 secret is needed to check the signature of auth0 JWT sent the API to the /login call.

export AUTH0_SECRET: "secret"
export AUTH0_ALGO: "HS256"
export AUTH0_ENDPOINT: "https://packebian.eu.auth0.com"

JWT

After the auth0 token is checked and authentication is done, a JWT is given to the user. It is that token that must be used to call the API. The following parameters are used to configure these tokens.

export JWT_SECRET="secret"
export JWT_LIFE=3600
export JWT_ALGO="HS256"
export JWT_ISSUER="packebian.com"
export JWT_AUDIENCE="packebian.com"

Build & development

The application is built and served with npm

$ npm start

Testing

The tests are run with npm

$ npm test

The npm modules used for testing are

• mocha
• supertest
• chai
• Barrel