Fastify template

This project template serves as a starting point for building efficient and scalable server-side applications with Fastify, TypeScript, and best practices in place. It comes pre-configured with essential tools to ensure code quality, maintainability, and a streamlined development workflow.

Features

• Fastify: A fast and low overhead web framework for Node.js.
• TypeScript: Static typing with TypeScript, enhancing code quality and developer productivity.
• Prettier & ESLint: Automatic code formatting and linting for consistent code style and adherence to best practices.
• Bun: Runtime environment, bundler and unit, feature, and acceptance tests.
• Husky: Git hooks for running linting and tests before commits, ensuring code quality standards are met.
• TypeDoc: Automatic generation of TypeScript documentation for improved code clarity and collaboration.

Installation

bun install --frozen-lockfile

Running the app

# Development in watch mode
bun run dev

# Production mode
bun run build && bun run start

With Docker

docker build -t fastify-template . && docker run --rm fastify-template

With Docker Compose

# There are multiple profiles that can be run:
# dev -> Mounts the current directory to the container and runs the service in watch mode
# local -> Builds and runs the application image from the current code
docker compose --profile <PROFILE> up --build

Database

You may need to run bunx --bun prisma migrate dev --name init in your terminal if you haven't already initialized the database. This only needs to be done the first time the database is created. (Or whenever the database has been recreated) This will happen automatically when using any profile in Docker Compose.

Test

Lint

Eslint is used as a linter and uses Prettier to format code.

# ESLint
bun run lint

# ESLint and fix (also sorts JSON files)
# Prefix with `EXCLUDE_PATHS="<file_1> <file_2>"` to exclude files/directories (using GLOB pattern) from being auto-sorted
bun run lint:fix

# Sort a specific JSON file and/or directory
# Important: Don't run this command without a specified file/directory (using GLOB pattern)
bunx jsonsort "<file_1> <file_2>"

Unit & Feature tests

# Unit tests
bun run test
bun run test:coverage

# Feature tests
bun run test:feature

# Prefix either command with `SHOW_LOGS=true` to show logs

Acceptance tests

bun run test:acceptance
bun run test:acceptance:coverage

With Docker Compose

# Run once and exit
docker compose --profile test up --build --attach acceptance-once --exit-code-from acceptance-once

# Run multiple times
# There are multiple profiles that can be run for the acceptance tests:
# dev
# local
docker compose --profile <PROFILE> up --build -d && docker compose --profile <PROFILE> exec -ti dev sh -c "bun run test:acceptance"

Integrity

Run this after a Bun install to verify that everything still works.

bun run integrity

License

This project is licensed under the MIT License. Feel free to customize and use it for your own projects.