Skip to content

README.md

Latest commit

 

History

History
63 lines (43 loc) · 1.47 KB

README.md

File metadata and controls

63 lines (43 loc) · 1.47 KB

Node.js starter using Fastify & TypeScript

ci badge Sync Vulnerabilities Status

Create a new server:

pnpx degit yonathan06/fastify-typescript-starter my-server

or npx.

See degit docs for detailed explaination

Included in the boilerplate

  • TypeScript (using esbuild for fast compilation, and tsx for development)
  • Env vars
  • Tests (using Vitest)
  • Fastify
  • CI with github actions
  • Docker image
  • Linting

BYODB - Bring your own database - no database connection included

Set Up

  • Install the dependencies.
pnpm install

or npm/yarn

  • Start the server in development mode.
pnpm dev

or npm/yarn

Env vars

Loaded from .env file, with schema validation

Backend API Development

There are a number of handy commands you can run to help with development.

Command Action
pnpm run dev Run the server in dev mode, automatically restarts on file change
pnpm build Compile TypeScript to JavaScript
pnpm start Start JavaScript from 'build' directory
pnpm test Run unit tests (run pnpm build before)
pnpm lint Run biome check

CI

Run tests on push/PR to 'main' branch Check .github/workflows/CI.yml