https://github.com/inadarei/nodebootstrap-cli
CLI (command-line) node project template for Nodebootstrap
https://github.com/inadarei/nodebootstrap-cli
cli node scaffolding
Last synced: 6 months ago
JSON representation
CLI (command-line) node project template for Nodebootstrap
- Host: GitHub
- URL: https://github.com/inadarei/nodebootstrap-cli
- Owner: inadarei
- License: mit
- Created: 2014-05-11T07:16:27.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-03-25T07:23:27.000Z (7 months ago)
- Last Synced: 2025-04-23T22:53:46.648Z (6 months ago)
- Topics: cli, node, scaffolding
- Language: JavaScript
- Homepage: http://www.nodebootstrap.io
- Size: 54.7 KB
- Stars: 1
- Watchers: 4
- Forks: 2
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nodebootstrap-microservice
[![Code Climate Badge][codeclimate-img]][codeclimate-url]
A skeleton of a containerized microservice generated by [Node Bootstrap](http://nodebootstrap.io)
## 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
```
Install a package in dev-dependencies:
```
npm run install-dev-package
```
## Running Automated Tests
1. Run: `make test`
## License
[MIT](LICENSE)
[codeclimate-img]: https://codeclimate.com/github/inadarei/nodebootstrap-microservice/badges/gpa.svg
[codeclimate-url]: https://codeclimate.com/github/inadarei/nodebootstrap-microservice