https://github.com/nikumu/backend-typed
https://github.com/nikumu/backend-typed
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nikumu/backend-typed
- Owner: nikumu
- Created: 2025-01-14T02:10:02.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-01-23T22:55:01.000Z (12 months ago)
- Last Synced: 2025-05-16T14:50:47.940Z (8 months ago)
- Language: TypeScript
- Size: 11.3 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Backend Typed
Welcome! Here you’ll find a comprehensive guide to building self-descriptive APIs using **Fastify**, a fast and efficient Node.js framework. This project integrates **TypeScript**, **Zod**, and **Swagger** to deliver a robust development and documentation experience.
## 🛠️ Key Features
- **Fastify Setup with TypeScript**: Learn how to initialize and configure your backend using **pnpm**.
- **CORS Configuration**: Enable cross-origin communication for your backend.
- **Data Validation and Serialization with Zod**: Implement robust validations and generate schemas for API documentation.
- **Swagger Documentation**: Integrate Swagger with Fastify to document your APIs clearly and efficiently.
- **Route Organization**: Group and organize routes with tags for better navigation in Swagger.
- **Direct Testing in Swagger**: Test and validate your routes directly in the Swagger interface.
- **Fastify vs. Express Comparison**: Discover why Fastify might be a better choice for updates and modern features.
- **Frontend Autogeneration**: Integrate tools to automatically generate frontend files from API documentation.
## 📦 Project Setup
### Prerequisites
- Node.js 16+
- pnpm installed globally
### How to Start
1. Clone this repository:
```bash
git clone https://github.com/nikumu/backend-typed.git
cd backend-typed
```
2. Install dependencies:
```bash
pnpm install
```
3. Start the development server:
```bash
pnpm run dev
```