nodecube-example

Boilerplate code and a demo for HTTP API projects based on nodecube.

• nodecube: nodecube is a batch of continuously updated base code and configurations for the minimal modern node.js service that conform to RESTful API, 12-Factor App, Microservice Architecture
• nodecube-cli: TODO

Setup

cp configs/env.sample.config env.config

For developers in China:

cp ./node_modules/nodecube/configs/Dockerfile-china Dockerfile-dev

For other developers:

cp Dockerfile Dockerfile-dev

Install dependencies

yarn

Create or update containers for development environment

Remove all old containers and images, build new ones and run testing

npm run dev:rebuild

Just remove database containers and images

npm run dev:empty

Just remove all containers and images

npm run dev:reset

Update

Reinstall all dependencies and update lock file

npm run upgrade
npm run dev:rebuild

Local testing

npm run lint

npm run dev:test

Running in development environment

npm run dev

npm run dev:debug

Running in production (or staging) environment

Need a new docker-compose.yml with reconfigured environment variables

Continuous integration

Send pull request to master branch

Continuous deployment

Send pull request to production (or staging) branch