fastify-initializr-ts

A modern Fastify boilerplate built with TypeScript and integrated Swagger documentation for fast and scalable API development — with optional Prisma database setup.

🛠️ Installation

Install globally:

npm install -g fastify-initializr-ts

Then run:

npx fastify-initializr-ts

⚙️ Database setup (optional)

During setup, you'll be asked whether you want to configure a database with Prisma. If you say yes, you'll also choose a provider:

• PostgreSQL (Supabase / Neon / default)
• MySQL / PlanetScale
• SQLite (local / Turso / libSQL)
• MongoDB
• SQL Server
• CockroachDB

Based on your choice, the CLI configures the right Prisma adapter, connection strings, and generates lib/prisma.ts accordingly. If you skip this step, the lib, prisma folders and prisma.config.ts are removed, and Prisma-related dependencies are stripped from package.json.

📦 Dependencies & Documentation

Runtime dependencies

• Fastify — Web framework for Node.js focused on performance and low overhead.
• Zod — TypeScript-first schema validation library.
• @fastify/swagger — Generates OpenAPI/Swagger documentation for Fastify APIs.
• @fastify/swagger-ui — Swagger UI integration for Fastify.
• fastify-type-provider-zod — Zod type provider integration for Fastify.
• Prisma Client (optional) — Type-safe database client, included when a database is configured.
• dotenv (optional) — Loads environment variables from .env, included when a database is configured.

Development dependencies

• TypeScript — JavaScript superset with static typing support.
• TSX — TypeScript execution environment powered by esbuild.
• @types/node — Type definitions for Node.js.
• Prisma CLI (optional) — Schema management, migrations, and client generation, included when a database is configured.

🤝 Contributing

Contributions are welcome! Feel free to open issues and submit pull requests.

Branches

feature/<issue-id>

Commits

<type>(<issue-id>): <description>

Types

• feat — new feature
• fix — bug fix
• docs — documentation
• refactor — code refactor
• test — tests
• chore — maintenance
• ci — CI/CD changes

📜 License

This project is licensed under the GPL-3.0.