NODEJS-BOILERPLATE 2.0

Studio Hyperdrive Node.js 2.0 boilerplate

Setup

System requirements

• Docker
• Node.js (LTS)

Node.js is optional and only required if you want to run the linters in your IDE. Running them inside Docker works without Node.js.

Installation

Update the values (if needed) of the local config file inside ./server/.env/local.env.

Start the Docker container:

$ docker-compose up

Optional: Install the Node.js packages locally:

$ yarn

Getting started

Once your Docker container is running, your application is accessible on localhost:3000 (assuming you did not change the port in the local config file).

Running linter

Running TSlint inside Docker:

$ docker-compose exec server yarn run lint

Running tests

Running tests inside Docker:

$ docker-compose exec server yarn run test

Bugs

In case of bugs, issues, questions, ... check the issues on Github.

Contributions

Contributions through pull requests are more than welcome. Make sure you respect the current tools, guidelines and flow to get your improved version accepted.

License

See LICENSE.