{"id":16327312,"url":"https://github.com/bryopsida/node-grpc-starter","last_synced_at":"2025-10-25T16:36:47.869Z","repository":{"id":223401743,"uuid":"760041943","full_name":"bryopsida/node-grpc-starter","owner":"bryopsida","description":"A bare bones starter template for a node gRPC micro service","archived":false,"fork":false,"pushed_at":"2025-07-07T18:46:45.000Z","size":446,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-07T22:36:04.033Z","etag":null,"topics":["grpc","nodejs","starter-template"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bryopsida.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-02-19T17:12:35.000Z","updated_at":"2025-07-07T18:46:49.000Z","dependencies_parsed_at":"2024-04-29T09:31:29.400Z","dependency_job_id":"f325056e-54f9-42b5-8425-22a357995468","html_url":"https://github.com/bryopsida/node-grpc-starter","commit_stats":null,"previous_names":["bryopsida/node-grpc-starter"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/bryopsida/node-grpc-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fnode-grpc-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fnode-grpc-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fnode-grpc-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fnode-grpc-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bryopsida","download_url":"https://codeload.github.com/bryopsida/node-grpc-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bryopsida%2Fnode-grpc-starter/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264167241,"owners_count":23567034,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["grpc","nodejs","starter-template"],"created_at":"2024-10-10T23:11:03.858Z","updated_at":"2025-10-25T16:36:42.831Z","avatar_url":"https://github.com/bryopsida.png","language":"JavaScript","readme":"# node-grpc-starter\n\n## What is this?\n\nA bare bones Node.JS gRPC starter template. It does not use typescript, it does not use any additional frameworks.\n\nIt provides boilerplate to start a gRPC microservice using an example echo service `.proto` file and dynamic bindings.\n\n### Dependencies\n\n- @grpc/grpc-js (core gRPC server)\n- @grpc/proto-loader (.proto parser for dynamic bindings)\n- @grpc/reflection (provide reflection calls for method discovery in clients like Postman)\n- grpc-health-check (provide health endpoints)\n- pino (logger)\n- dotenv (configuration)\n\n### Dev. Dependencies\n\n- nodemon (hot reloading on change)\n- standard (opinionated code linting)\n- node-forge (boostraps PKI for mTLS E2E testing in CI)\n- testcontainers (verify container builds and runs)\n- jsdoc (create html documentation folder from code comments)\n\n`node --test` is used for testing instead of bringing in a library/framework.\n\n## Scripts\n\nScripts available in package.json\n\n- `build:image` builds a docker image\n- `build:docs` builds the docs folder using jsdoc\n- `build:context` creates a folder showing the files sent to the docker build context under the context folder\n- `lint` runs standard lint checks\n- `lint:fix` fixes all auto correctable lint failures\n- `start` runs the server\n- `start:dev` runs the server using nodemon and reloads on change\n- `test` runs tests\n\n## Workflows\n\nA github workflow is included that\n\n1. Runs unit tests and lint checks\n2. Runs npm audit checks\n3. Builds multi-platform docker image\n4. Scans image using trivy and uploads results to GitHub\n\n## Environment Variables\n\n| Name                            | Description                                                                                                                          | Default |\n| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------- |\n| SERVER_PORT                     | Bind port of the server                                                                                                              | 3000    |\n| SERVER_CA_CERT                  | String value of the CA in PEM format                                                                                                 |         |\n| SERVER_KEY_PAIRS                | JSON array, each object containing a key and cert property                                                                           |         |\n| SERVER_VALIDATE_CLIENT_CERT     | Boolean toggling whether or not the server will validate the client certificate, when set to true this enables mTLS                  | false   |\n| SERVER_SUPRESS_INSECURE_WARNING | When running without TLS a warning is logged, setting this to true disables that log message                                         | false   |\n| DOTENV_FILE_PATHS               | Comma seperated list of paths to .env files, if not provided `.env` is used, encrypted files should have a `.vault` ending extension |         |\n| DOTENV_DEBUG                    | When enabled debug messages from dotenv are logged                                                                                   | false   |\n| DOTENV_VAULT_KEY_PATH           | When set, this path is used to load a key for decrypting `.vault` dotenv files, when set has priority over DOTENV_VAULT_KEY          |         |\n| DOTENV_VAULT_KEY                | When set, this is used to decrypt `.vault` dotenv files                                                                              |         |\n| DOTENV_OVERRIDE                 | When set to true, values specified in `.env` files will override values already defined in the destination                           | false   |\n\n## Automated Dependency Updates\n\nA renovate configuration is provided to keep dependencies up to date and auto merge if tests pass.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryopsida%2Fnode-grpc-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbryopsida%2Fnode-grpc-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryopsida%2Fnode-grpc-starter/lists"}