bryopsida / node-grpc-starter
A bare bones starter template for a node gRPC micro service
★ 0 stars
⑂ 0 forks
👁 0 watching
grpcnodejsstarter-template
📥 Clone
https://github.com/bryopsida/node-grpc-starter.git
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4)
📂 main
View all commits →
📄 README.md
node-grpc-starter
What is this?
A bare bones Node.JS gRPC starter template. It does not use typescript, it does not use any additional frameworks.
It provides boilerplate to start a gRPC microservice using an example echo service .proto file and dynamic bindings.
Dependencies
- @grpc/grpc-js (core gRPC server)
- @grpc/proto-loader (.proto parser for dynamic bindings)
- @grpc/reflection (provide reflection calls for method discovery in clients like Postman)
- grpc-health-check (provide health endpoints)
- pino (logger)
- dotenv (configuration)
Dev. Dependencies
- nodemon (hot reloading on change)
- standard (opinionated code linting)
- node-forge (boostraps PKI for mTLS E2E testing in CI)
- testcontainers (verify container builds and runs)
- jsdoc (create html documentation folder from code comments)
node --test is used for testing instead of bringing in a library/framework.
Scripts
Scripts available in package.json
build:imagebuilds a docker imagebuild:docsbuilds the docs folder using jsdocbuild:contextcreates a folder showing the files sent to the docker build context under the context folderlintruns standard lint checkslint:fixfixes all auto correctable lint failuresstartruns the serverstart:devruns the server using nodemon and reloads on changetestruns tests
Workflows
A github workflow is included that
- Runs unit tests and lint checks
- Runs npm audit checks
- Builds multi-platform docker image
- Scans image using trivy and uploads results to GitHub
Environment Variables
| Name | Description | Default |
|---|---|---|
| SERVERPORT | Bind port of the server | 3000 |
| SERVERCACERT | String value of the CA in PEM format | |
| SERVERKEYPAIRS | JSON array, each object containing a key and cert property | |
| SERVERVALIDATECLIENTCERT | Boolean toggling whether or not the server will validate the client certificate, when set to true this enables mTLS | false |
| SERVERSUPRESSINSECUREWARNING | When running without TLS a warning is logged, setting this to true disables that log message | false |
| DOTENVFILEPATHS | Comma seperated list of paths to .env files, if not provided .env is used, encrypted files should have a .vault ending extension | |
| DOTENVDEBUG | When enabled debug messages from dotenv are logged | false |
| DOTENVVAULTKEYPATH | When set, this path is used to load a key for decrypting .vault dotenv files, when set has priority over DOTENVVAULTKEY | |
| DOTENVVAULTKEY | When set, this is used to decrypt .vault dotenv files | |
| DOTENVOVERRIDE | When set to true, values specified in .env files will override values already defined in the destination | false |
Automated Dependency Updates
A renovate configuration is provided to keep dependencies up to date and auto merge if tests pass.