https://github.com/dillonstreator/template-node-express
A minimal production-ready node HTTP server with express and typescript
https://github.com/dillonstreator/template-node-express
expressjs graceful-shutdown nodejs railway-template starter starter-template typescript
Last synced: 3 months ago
JSON representation
A minimal production-ready node HTTP server with express and typescript
- Host: GitHub
- URL: https://github.com/dillonstreator/template-node-express
- Owner: dillonstreator
- Created: 2023-11-19T22:37:49.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-06T15:53:52.000Z (5 months ago)
- Last Synced: 2025-06-13T06:41:15.986Z (4 months ago)
- Topics: expressjs, graceful-shutdown, nodejs, railway-template, starter, starter-template, typescript
- Language: TypeScript
- Homepage: https://railway.app/template/KwYYFA?referralCode=ToZEjF
- Size: 953 KB
- Stars: 2
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `template-node-express`
A minimal production-ready node HTTP server with [`Express`](https://expressjs.com/) and Typescript.
✅ Typescript \
✅ Graceful shutdown \
✅ Optional Tracing with OpenTelemetry (configurable via environment variables) \
✅ Properly configured request payload size limiting to help prevent Denial of Service attack vectors \
✅ `AbortSignal` propagation to prevent unnecessary work (includes example and test) \
✅ Validation with [`express-validator`](https://express-validator.github.io/docs) \
✅ Async error forwarding to default error handler with [`express-async-errors`](https://github.com/davidbanham/express-async-errors) \
✅ Structured logging with [`pino`](https://github.com/pinojs/pino) \
✅ Rich request logging middleware including request id, trace id, context propagation, and more \
✅ Testing with [`jest`](https://github.com/jestjs/jest), [`supertest`](https://github.com/ladjs/supertest), and [`fetch-mock`](https://github.com/wheresrhys/fetch-mock) \
✅ [`helmet`](https://github.com/helmetjs/helmet) & [`compression`](https://github.com/expressjs/compression)
[](https://railway.app/template/KwYYFA?referralCode=ToZEjF)
## Installation
```sh
git clone https://github.com/dillonstreator/template-node-express
cd template-node-express
yarn install
yarn dev
```
## Configuration
See all example configuration via environment variables in [`.env-example`](./.env-example)
### Open Telemetry
Open Telemetry is disabled by default but can be enabled by setting the `OTEL_ENABLED` environment to `true`.
By default, the trace exporter is set to standard output. This can be overridden by setting `OTEL_EXPORTER_OTLP_ENDPOINT`.
Start the `jaegertracing/all-in-one` container with `docker-compose up` and set `OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318` to collect logs in jaeger. Docker compose will expose jaeger at http://localhost:16686