Fastify Starter

🐆 A boilerplate for API Server with Node.js, Fastify, and MongoDB on Vite.

🌈 View Demo: Live | Windows | macOS | Android | iOS

Source Code: Web-side | Native-side | Server-side

Table of Contents

• Getting Started
• Project Setup
• Key Features
• Configuration
• Directory Structure

Getting Started

Prerequisites:

• Node.js v20
• PNPM v9
• Docker (Optional)
• Pulumi (Optional)
• Azure (Optional)

Get started with Fastify Starter.

# (optional)
# If you already have the MONGODB_URL and REDIS_URL connections,
# you can directly replace them.

# mongo server
$ docker compose up -d local-mongo

# redis server
$ docker compose up -d local-redis

# install dependencies
$ pnpm install

# dev server (in one terminal)
$ pnpm dev

# (negligible)
# The current demo doesn't make any calls to third-party or internal APIs.
# mock server (in another terminal)
$ pnpm mock

Or use barebones scaffolding for your new Fastify app

$ pnpm dlx degit Shyam-Chen/Starter-Templates/fastify my-fastify-app

Project Setup

Follow steps to execute this boilerplate.

Install dependencies

$ pnpm install

Compiles and hot-reloads for development

$ pnpm dev

Mock third-party/private APIs during development

$ pnpm mock

Compiles and minifies for production

$ pnpm build

Locally preview the production build

# Before running the `preview` command, make sure to run the following commands.
$ pnpm build

$ pnpm preview

Lints and fixes files

Files: {app,db,mock,e2e,docs,infra}/**/*.ts

$ pnpm lint

Check types

Files: app/src/**/*.ts

$ pnpm check

Runs unit tests

Files: app/src/**/*.spec.ts

$ pnpm test

Runs end-to-end tests

Files: e2e/src/**/*.spec.ts

# Before running the `e2e` command, make sure to run the following commands.
$ pnpm build
$ pnpm preview

$ pnpm e2e

Key Features

This seed repository provides the following features:

• ---------- Essentials ----------
• Fastify - Web Application Framework
• Routes - File-based Routing
• MongoDB - Document Database
• JWT - Authentication
• PBKDF2 - Hash Passwords
• OTP - Authenticator
• Cloudinary - Asset Management
• I18n - Internationalization and Localization
• Redis - In-memory Data Structure Store
• WebSocket - Two-way Interactive Communication Session
• EventSource - Server-sent Events
• Mailer - Email Sending
• Email - Email Builder
• Nunjucks - Email Rendering
• BullMQ - Message Queue
• ---------- Tools ----------
• Vite - Bundler
• TypeScript - JavaScript with Syntax for Types
• Biome - Formatter and Linter
• Vitest - Test Runner
• Playwright - Test Automation
• ---------- Environments ----------
• Node.js - JavaScript Runtime Environment
• Pnpm - Package Manager
• Caddy - Web Server
• Docker - Containerized Application Development
• GitHub Actions - Continuous Integration and Delivery
• Render - Cloud Application Hosting

Tiny examples

• Hello World
• CRUD Operations
• JWT Authentication
• One-time Password
• File Uploads
• Real-time Data
• Real-time Updates
• Sending Emails
• Internationalization
• Caching (Or use Redis Store)
• Cache Deduplication (Or use Redis Store)
• Background Workers (Or use Redis Store)
• Cron Jobs (Or use Redis Store)

Configuration

Control the environment.

Default environments

Set your local environment variables.

// app/vite.config.ts
  define: envify({
    NODE_ENV: process.env.NODE_ENV || 'development',

    HOST: process.env.HOST || '127.0.0.1',
    PORT: process.env.PORT || 3000,

    SITE_URL: process.env.SITE_URL || 'http://127.0.0.1:5173',

    MONGODB_URL: process.env.MONGODB_URL || 'mongodb://root:[email protected]:27017/mydb',
    REDIS_URL: process.env.REDIS_URL || 'redis://127.0.0.1:6379',
    CLOUDINARY_URL: process.env.CLOUDINARY_URL || 'cloudinary://apikey:apisecret@cloudname',
    SMTP_URL: process.env.SMTP_URL || `smtp://${user}:${pass}@smtp.ethereal.email:587`,

    SECRET_KEY: process.env.SECRET_KEY || 'jbmpHPLoaV8N0nEpuLxlpT95FYakMPiu',
  }),

Continuous integration environments

Add environment secrets to the GitHub Actions workflow.

DEPLOY_HOOK=xxx

Continuous delivery environments

Add environment variables to the Render build.

SITE_URL=xxx

MONGODB_URL=xxx
REDIS_URL=xxx
CLOUDINARY_URL=xxx
SMTP_URL=xxx

SECRET_KEY=xxx

Directory Structure

The structure follows the LIFT Guidelines.

.
├── .github/workflows/ci.yml
├── app
│   ├── public
│   ├── src
│   │   ├── assets
│   │   ├── components
│   │   ├── composables
│   │   ├── jobs
│   │   ├── locales
│   │   ├── middleware
│   │   ├── plugins
│   │   ├── routes
│   │   ├── templates
│   │   ├── utilities
│   │   ├── app.ts
│   │   ├── main.ts
│   │   ├── shims.d.ts
│   │   └── worker.ts
│   ├── package.json
│   ├── tsconfig.json
│   └── vite.config.ts
├── db -> Set up local data for initializing and testing the database
│   ├── src
│   ├── mongo-init.js
│   └── package.json
├── docs -> Write API documentation with VitePress
│   ├── .vitepress
│   │   └── config.ts
│   ├── index.md
│   └── package.json
├── e2e -> API End-to-end testing
│   ├── src
│   ├── package.json
│   ├── playwright.config.ts
│   └── tsconfig.json
├── infra -> Infrastructure as code
│   ├── src
│   ├── package.json
│   ├── Pulumi.yaml
│   └── tsconfig.json
├── mock -> Mocking third-party or private API calls
│   ├── src
│   ├── package.json
│   ├── tsconfig.json
│   └── vite.config.ts
├── .dockerignore
├── .editorconfig
├── .gitignore
├── biome.json
├── Caddyfile
├── compose.yaml
├── Dockerfile
├── package.json
├── pnpm-lock.yaml
├── pnpm-workspace.yaml
├── README.md
└── render.yaml