🚀 A modern and performant starter for building REST APIs with Fastify and TypeScript.
- ⚡ Fastify - Ultra-fast web framework
- 🔷 TypeScript - Static typing and better DX
- 🔧 Hot Reload - Automatic reload in development
- 📁 Modular structure - Clean organization of plugins and routes
- 🛡️ Type Safety - Custom TypeScript declarations
- Node.js (version 18 or higher)
- npm or yarn
# Clone the project
git clone <your-repo>
cd fastify-api-ts
# Install dependencies
npm install# Run in development mode (hot reload)
npm run devThe API will be available at http://localhost:8888
# Build the project
npm run build
# Run in production
npm start| Script | Description |
|---|---|
npm run dev |
Starts the server in development mode with hot reload |
npm run build |
Compiles TypeScript to JavaScript in /dist |
npm start |
Starts the server in production mode |
npm test |
Runs tests (to be configured) |
src/
├── app.ts # Fastify application configuration
├── server.ts # Server entry point
├── plugins/ # Custom Fastify plugins
│ ├── sensible.ts # Plugin for HTTP errors
│ └── support.ts # Global utilities
├── routes/ # Route definitions
│ ├── root.ts # Root route
│ └── example/ # Example routes
└── types/ # TypeScript declarations
└── fastify.d.ts # Fastify type extensions
- Create a file in
src/routes/ - Export a Fastify plugin function:
import { FastifyInstance } from 'fastify';
export default async function (fastify: FastifyInstance) {
fastify.get('/hello', async (request, reply) => {
return { message: 'Hello World!' };
});
}- Routes are automatically loaded by Fastify
Add your plugins in src/plugins/ and register them in src/app.ts.
Create a .env file at the root:
PORT=8888
NODE_ENV=development