https://github.com/zephinzer/node-microservice-boilerplate
Opinionated boilerplate for a Node.js based microservice.
https://github.com/zephinzer/node-microservice-boilerplate
Last synced: 2 months ago
JSON representation
Opinionated boilerplate for a Node.js based microservice.
- Host: GitHub
- URL: https://github.com/zephinzer/node-microservice-boilerplate
- Owner: zephinzer
- Created: 2018-04-18T03:51:27.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-04T07:22:56.000Z (about 7 years ago)
- Last Synced: 2025-02-01T18:27:10.367Z (4 months ago)
- Language: JavaScript
- Size: 7.81 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Microservice Boilerplate
## What's In This
- [x] express
- [x] cookie parser
- [ ] body parser
- [ ] helmet for http header security
- [ ] cors for cross-origin-resource-sharing
- [ ] prometheus metrics monitoring
- [ ] zipkin distributed tracing
- [ ] swagger tooling
- [ ] graphql tooling
## Usage
Install it to a new project:
```sh
npm i @govtechsg/microservice-boilerplate --save;
# or
yarn add @govtechsg/microservice-boilerplate;
```
Use it in the project:
```js
const server = require('@govtechsg/microservice-boilerplate');
// this returns a provisioned instance of an express server with standardised behaviour
```
## Developing
### Releasing the Package
Run `npm run release` locally, commit the changes made by the script and push to GitHub.