starter-node-repo

A blank, containerised repo with some useful modules installed to save time when starting a new project

Usage

Create a new repository from this template and run ./rename.js specifying the new name of the repository and the description to use e.g.

./rename.js my-new-repo "Really useful description"

Once the rename has been completed the script can be removed.

If there is an issue during the rename the changes can be reverted via git clean -df && git checkout -- .

Running the application

The application is containerised for Docker and can be run via docker or docker-compose commands. The easiest option is to use the convenience script (scripts/start) which includes the commands to start the application via docker-compose.

The commands to run the application with just docker are:

docker build . --build-arg NODE_ENV=development -t beer-quest

docker run --init -p 3000:3000 -p 9229:9229 -t beer-quest

Testing the application

Tests for the application can be run in one of two modes via the convenience script (scripts/test).

In order to run the tests once, simply run the script with no options i.e. ./scripts/test.

The tests can also be run in watch mode by passing -w to the script ./scripts/test -w. This will continually run the tests when file changes are detected and is a good option to use whilst developing the application.