A project to kickstart a node app, with the common things already setup.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
tools
.dockerignore
.editorconfig
.eslintrc.yml
.gitignore
.npmrc
.prettierrc.yml
Dockerfile
README.md
REGISTRY
package-lock.json
package.json

README.md

A Node Project

This project was setup with robb-j/node-base which creates a node app, with the common things already setup.

Template Features

  • Docker build to install dependancies and deploy
  • Testing & code coverage with jest
  • Code linting with eslint
  • Code formatting with prettier on git file stage
  • Semantically versioned docker images using npm version

Dev Commands

# Start the app
npm run start

# Start the app and reload on file changes
npm run watch

# Update version (builds & pushes a new docker image)
# -> Uses the REGISTRY file & the npm version to tag image
npm version ... # --help

# Lint the web & test directories
npm run lint

# Manually format code
# -> This repo runs prettier on git-stage, so code is always to standard
npm run prettier

# Run the unit tests
npm test

# Generate code coverage
npm run coverage          # outputs to coverage/