Quick Start¶

This guide will help you create your first fastappkit project in minutes.

Create a Project¶

Start by creating a new fastappkit project:

fastappkit core new myproject
cd myproject

This creates a complete FastAPI project structure:

myproject/
├── core/
│   ├── config.py          # Settings (loads from .env)
│   ├── app.py             # create_app() factory
│   ├── models.py          # SQLAlchemy Base class
│   └── db/
│       └── migrations/    # Core migrations
├── apps/                  # Internal apps directory
├── fastappkit.toml        # Project configuration
├── .env                   # Environment variables
└── main.py                # Entry point

Create an Internal App¶

Create your first app:

fastappkit app new blog

This creates apps/blog/ with models, router, and registers it in fastappkit.toml.

Run Migrations¶

Generate and apply migrations:

# Generate migration
fastappkit migrate app blog makemigrations -m "initial"

# Apply all migrations
fastappkit migrate all

Start Development Server¶

Run the development server:

fastappkit core dev

Your API is now running at http://127.0.0.1:8000 with routes mounted at /blog/.

What Gets Created¶

Project Structure¶

• core/: Core application code
  • config.py: Settings class (loads from .env)
  • app.py: FastAPI app factory
  • models.py: SQLAlchemy Base class
  • db/migrations/: Migration directory
• apps/: Internal apps directory
• fastappkit.toml: Project configuration (apps list)
• .env: Environment variables (auto-created)
• main.py: Application entry point

App Structure¶

• apps/blog/: Your first app
  • __init__.py: Registration function
  • models.py: SQLAlchemy models
  • router.py: FastAPI routes

Next Steps¶

Now that you have a working project:

• Read Core Concepts to understand how fastappkit works
• Follow the Creating Apps Guide for detailed app development
• Explore the Migration System for database management
• Check the CLI Reference for all available commands
• See Usage Scenarios for different development approaches
• Check out the Modular Tasks Platform example project to see fastappkit in action

Important Notes¶

• All commands must be run from project root (where fastappkit.toml is located)
• Update dependency versions in pyproject.toml from * to specific ranges for production
• Configure .env file with your DATABASE_URL and other settings
• Internal apps are automatically added to fastappkit.toml by the CLI