BRP Application project for nodejs
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
acceptance_tests
apps
assets
documentation
errors
lib
middleware
services/email
test
.dockerignore
.drone.yml
.editorconfig
.eslintignore
.eslintrc
.gitignore
.nodemonignore
.nvmrc
.snyk
CONTRIBUTING.md
Dockerfile
Dockerfile-acceptance
LICENSE.md
README.md
app.js
config.js
docker-compose.yml
hof.settings.json
package-lock.json
package.json
redirects.js
run.sh

README.md

BRP Application project for nodejs

Docker Repository on Quay.io Build Status

Quick start

Install the dependencies and build the project resources

$ npm install

Install Redis and make sure you have a running redis instance in the background.

Initiate the server in development mode (Express is used to serve the static resources in development).

$ npm run dev

Then select one of the following journeys to see the applcation in action

See the development documentation for a complete description of the application and how to maintain and support BRP.

NPM scripts

Start the application in default mode (production). We use Nginx to serve our static resources in production and ci.

$ npm start

Start the application with Nodemon in development mode. Debug is switched on and the server restarts when the JS or Sass are recompiled.

$ npm run dev

Run the unit tests

$ npm run test

Run the EcmaScript (ES) linter. Rules are defined in .eslintrc

$ npm run lint

Run the jscs style checker. Rules are defined in .jscsrc.json

$ npm run style

Analyse the quality of the codebase (for results - open ./reports/plato/index.html)

$ npm run quality

Compile the Sass to CSS

$ npm run sass