PNK Stack Service

⚠️ Still working out issues with my testing, but this is otherwise in a pretty good state ⚠️

Backend service template using PostgreSQL, Node, and Koa

See my outreach page's Node Template post

TL;DR

This is a template for a relatively production ready backend Node micro-service. It already has error handling, logging, observability, rate limiting, graceful shutdown, a test file, and Docker optimizations.

Development Quickstart

Prerequisites

1. Development environment setup through my guide
2. Node.js v20.10.0 (recommended to use nvm)
3. Docker

Setup

1. Ensure the Node.js version listed in the .nvmrc file is active:

nvm install && nvm use

2. Install dependencies:

make install-dev

3. Run locally at localhost:3000:

make dev

Test

1. Compose the Docker image:

docker compose up -d

2. Run the database migration:

docker compose exec app npx prisma migrate deploy

3. Test the code:

make test