https://github.com/inadarei/microservices-workspace-ms-demo-node
Demo microservice in Node, for Microservices Workspace demo project
https://github.com/inadarei/microservices-workspace-ms-demo-node
Last synced: 2 months ago
JSON representation
Demo microservice in Node, for Microservices Workspace demo project
- Host: GitHub
- URL: https://github.com/inadarei/microservices-workspace-ms-demo-node
- Owner: inadarei
- License: mit
- Created: 2017-03-12T18:43:34.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-08-13T20:40:46.000Z (about 3 years ago)
- Last Synced: 2025-02-03T14:29:05.221Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 32.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nodebootstrap-microservice
[![Code Climate Badge][codeclimate-img]][codeclimate-url]
[![NodeSecurity Status][nsp-img]][nsp-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]
# stop:
> make stop
# clean rebuild:
> make clean
```
Inspecting health of the containers:
```
> docker-compose ps
```
## Monitoring Logs:
```
> make logs
```
## Installing a new packagey
Installing a package:
```
npm run install-package
```
Install a package in dev-dependencies:
```
npm run install-dev-package
```
## Database Migrations (Currently: MySQL)
```
# Create migration:
> npm run migration-create
# e.g.:
> npm run migration-create create-users-table
# Run migrations:
> make migrate
```
## Accessing the microservice:
http://localhost:5501/
## Running Automated Tests
1. Make sure the microservice is up (if not: run `make clean` or `make start`)
2. 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
[nsp-img]: https://nodesecurity.io/orgs/inadarei-public/projects/d639c395-08dd-4297-aeb5-87fcfa08cd3c/badge
[nsp-url]: https://nodesecurity.io/orgs/inadarei-public/projects/d639c395-08dd-4297-aeb5-87fcfa08cd3c