Skip to content

inadarei/nodebootstrap-cli

Repository files navigation

nodebootstrap-microservice

Code Climate Badge

A skeleton of a containerized microservice generated by Node Bootstrap

Developing code in local workspace

Please note: we follow the philosophy of clean separation between "build" and "run" stages.

In the build stage, the Dockerfile is used to build the container image and bring it to a state where it can be run by any execution environment (such as: Swarm, Kubernetes, ECR, etc.) given that the environment will also contextualize it using appropriate environmental variables.

In the run stage execution environment runs the container image built by the Dockerfile. For local development docker-compose.yml takes the role of the executor. it is the simplest solution for the task and we prefer keeping things simple, locally.

Please note that in the local environment code hot-reloading is turned on, so there is no need to restart the container as you develop code, just edit the corresponding files and enjoy the experience!

Run/Stop container:

# run:
> make [start]
# run with arguments:
> make ARGS="irakli"
> make ARGS="-t 3 --period=morning irakli"

# stop:
> make stop

# clean rebuild:
> make clean

Inspecting health of the containers:

> docker-compose ps

Monitoring Logs:

> make logs

Installing a new package

Installing a package:

npm run install-package <packagename>

Install a package in dev-dependencies:

npm run install-dev-package <packagename>

Running Automated Tests

  1. Run: make test

License

MIT

About

CLI (command-line) node project template for Nodebootstrap

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •