---

Forge is a CLI tool that generates production-ready FastAPI projects. It collects your preferences through an interactive terminal interface, saves them to a configuration file, then generates a complete project structure with all the boilerplate code you need.

pip install ningfastforge
forge init

Why Forge?

Every time you start a new FastAPI project, do you find yourself repeating the same tasks?

• Setting up database connections and ORM configuration

• Implementing JWT authentication and user management

• Integrating Redis caching and Celery task queues

• Writing Docker and deployment configurations

• Configuring test frameworks and CI/CD pipelines

Forge was built to solve this problem.

As a FastAPI developer, I got tired of building the same infrastructure from scratch for every new project. While there are many templates available online, they’re either too simple or too complex to customize.

Forge’s design philosophy:

• Generate on demand: Only generate what you need, nothing more, nothing less

• Production-ready: Generated code follows best practices and is ready for production

• Easy to understand: Clean code structure that’s easy to maintain and extend

• Quick start: Go from zero to a complete project skeleton in minutes

Features

• Database Support: PostgreSQL, MySQL, SQLite with SQLModel or SQLAlchemy ORM

• Authentication: JWT-based auth with two modes (basic or complete with email verification)

• Caching: Redis integration for caching and session management

• Background Tasks: Celery with Redis broker for async task processing

• Testing: Pre-configured pytest with async support

• Deployment: Docker and Docker Compose configurations

• Migrations: Alembic database migrations

Getting Started

• Installation
  • Requirements
  • Install from PyPI
  • Verify Installation
  • Install from Source
  • Optional Dependencies
  • Next Steps
• Quickstart
  • Create a Project
  • Project Structure
  • Run the Project
  • Access the API
  • What’s Next
• Your First Project
  • Creating the Project
  • Understanding the Generated Code
  • Setting Up the Database
  • Running the Application
  • Testing the API
  • Running Tests
  • Next Steps

User Guide

• Configuration
  • Configuration File Structure
  • Project Information
  • Database Configuration
  • Feature Flags
  • Environment Variables
  • Modifying Configuration
• Database
  • Supported Databases
  • ORM Options
  • Database Connection
  • Database Migrations
  • Adding New Models
  • CRUD Operations
  • Docker Database Setup
• Authentication
  • Authentication Types
  • Security Components
  • API Endpoints
  • Authentication Flow
  • Using Authentication in Routes
  • Email Configuration
  • JWT Configuration
  • Database Models
  • Security Best Practices
• Redis Caching
  • Configuration
  • RedisManager
  • Available Methods
  • Common Use Cases
  • Connection Management
  • Docker Setup
• Celery Background Tasks
  • Prerequisites
  • Configuration
  • Celery Application
  • Writing Tasks
  • Calling Tasks
  • Scheduled Tasks
  • Built-in Database Backup Task
  • Running Celery
  • Monitoring with Flower
  • Best Practices
• Testing
  • Test Structure
  • Configuration
  • Fixtures
  • Writing Tests
  • Running Tests
  • Test Database
  • Best Practices
• Deployment
  • Generated Files
  • Docker Architecture
  • Dockerfile
  • Docker Compose Services
  • Deployment Steps
  • Managing the Deployment
  • Production Considerations
  • Example: Production docker-compose Override
• Best Practices
  • Project Structure
  • Security
  • Database
  • API Design
  • Performance
  • Testing
  • Logging
  • Code Quality

Architecture

• Architecture Overview
  • High-Level Flow
  • Core Components
  • Generator Categories
  • Dependency Resolution
  • Conditional Generation
  • Generated Project Architecture
• Generator System
  • Components
  • Execution Flow
  • Dependency Resolution
  • Conditional Execution
  • Generator Implementation
  • Current Generators

API Reference

• ConfigReader API
  • Location
  • Constructor
  • Methods
  • Configuration Structure
  • Usage in Generators
• @Generator Decorator
  • Location
  • Signature
  • Parameters
  • How It Works
  • Examples
  • Accessing the Registry
  • Common Patterns
• GeneratorOrchestrator
  • Location
  • Constructor
  • Methods
  • Internal Process
  • Error Handling
  • Usage in ProjectGenerator
  • Execution Order Example
  • Debugging

Developer Guide

• Development Setup
  • Prerequisites
  • Clone the Repository
  • Install Dependencies
  • Project Structure
  • Running Locally
  • Running Tests
  • Code Quality
  • Building
  • Version Management
  • Development Workflow
  • Key Files to Understand
  • Debugging Tips
• Creating Generators
  • How Generators Work
  • Generator Structure
  • @Generator Decorator Parameters
  • BaseTemplateGenerator
  • Using ConfigReader
  • Using FileOperations
  • Complete Example
  • Generator File Locations
• Adding New Features
  • Overview
  • Example: Adding GraphQL Support
  • Checklist for New Features
  • Tips

Additional

• Changelog

Links

• GitHub: ning3739/forge

• PyPI: ningfastforge

• Issues: Report bugs