https://github.com/Olivr/app-node-js

Node.js boilerplate. Docker and Kubernetes ready. Observability (health, logs, metrics, traces) included.
https://github.com/Olivr/app-node-js

boilerplate docker jaeger kubernetes logs metrics observability opentelemetry ostack ostack-app pino prometheus tilt tracing

Last synced: 24 days ago
JSON representation

Node.js boilerplate. Docker and Kubernetes ready. Observability (health, logs, metrics, traces) included.

• Host: GitHub
• URL: https://github.com/Olivr/app-node-js
• Owner: Olivr
• License: apache-2.0
• Created: 2021-10-25T09:24:44.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-14T23:55:47.000Z (2 months ago)
• Last Synced: 2024-04-22T05:15:25.535Z (2 months ago)
• Topics: boilerplate, docker, jaeger, kubernetes, logs, metrics, observability, opentelemetry, ostack, ostack-app, pino, prometheus, tilt, tracing
• Language: JavaScript
• Homepage:
• Size: 479 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-observability - Node.js boilerplate app (JavaScript) - Docker and Kubernetes ready. Observability (logs, metrics, traces) included. (13. Examples and Sandbox's / Anomalies Detection)
• awesome-observability - Node.js boilerplate app (JavaScript) - Docker and Kubernetes ready. Observability (logs, metrics, traces) included. (13. Examples and Sandbox's / Anomalies Detection)

README

        
# Node.js App (Javascript)

Production-ready Node.js app.

## Key features

- Local development on your native Node.js installation or any combination of:

  - **Image**: Development ([Official Node.js image](https://hub.docker.com/_/node)), Production ([Official distroless image](https://github.com/GoogleContainerTools/distroless)), Production debugging ([Official distroless debug image](https://github.com/GoogleContainerTools/distroless#debug-images))

  - **Environment**: Docker, Kubernetes

- Multi-stage Docker build

- Live reload for faster development feedback

- Pre-configured VS Code debugger

- Full observability (health, logs, metrics, traces)

- Graceful shutdowns

- Auto-publish signed images

- Example deployments to Kubernetes, Heroku and Fly

## Getting started

1. Create your own repo [from this template](https://github.com/Olivr/app-node-js/generate) or [fork it](https://github.com/Olivr/app-node-js/fork)

2. Clone your repo to your computer

3. Search and replace `app-node-js` with your app name (this should update `package.json`, k8s manifests, docs)

4. Search and replace `your app` with your app title (this should update docs)

5. Remove this **Getting started** section

6. Commit your changes!

## [Develop](docs/development.md)

## [Release](docs/release.md)

## [Deploy](docs/deployment.md)

## [Observe](docs/observability.md)