Skip to content

Mohammad222PR/fastapi-cookiecutters

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 FastAPI Cookiecutter
⚡ Your Ultimate FastAPI Project Starter ⚡

Stars Forks Issues License


📖 What is FastAPI Cookiecutter?

FastAPI Cookiecutter is a badass template for generating production-ready FastAPI projects in minutes. Built for developers who hate boilerplate and love flexibility, it’s packed with:

  • 🛠️ Modular Blueprint: Pre-structured for APIs, models, and services.
  • 🌍 Database Choices: PostgreSQL or SQLite, you decide.
  • Optional Boosts: Docker, Redis, CI/CD—pick what you need.
  • 🔍 Pro Tools: Health checks, migrations, and tests out of the box.

Why This Template?

  • Instant Start: Zero-to-API faster than you can say "REST".
  • 🔧 Total Control: Customize with a few quick prompts.
  • 🌐 Scales Hard: From side projects to enterprise beasts.
  • 📊 Clean Code: Structure that actually makes sense.

✨ Features

Feature Description
🚀 FastAPI Base Async-powered API goodness.
🌍 DB Options SQLite or PostgreSQL on tap.
Redis Power Add caching with a single "yes".
🐳 Docker Vibes Containerize it—or don’t. Your call.
🤖 CI/CD Flow GitHub Actions, optional and awesome.

🚀 Get Started

  1. Install Cookiecutter:
    pip install cookiecutter
  2. Generate a Project:
    cookiecutter gh:Mohammad222PR/fastapi-cookiecutters
    Replace Mohammad222PR with your GitHub username.
  3. Customize It: Answer the prompts—name your project, pick a DB, add Docker, whatever you’re feeling.

Boom! Your FastAPI app is ready to roll.


🔧 Usage Examples

# Basic setup (SQLite, no extras)
cookiecutter gh:Mohammad222PR/fastapi-cookiecutters

# Full power (Postgres, Docker, Redis, CI/CD)
cookiecutter gh:Mohammad222PR/fastapi-cookiecutters --no-input \
  project_name="MyAPI" database="postgres" use_redis="yes" use_docker="yes" use_ci_cd="yes"

Check the generated README.md for what’s next!


🤝 Contributing

Dig this template? Let’s make it epic!

  1. Fork it 🍴
  2. Clone it:
    git clone https://github.com/Mohammad222PR/fastapi-cookiecutter.git
    cd fastapi-cookiecutter
    pip install -r requirements.txt
  3. Test your changes:
    cookiecutter . --no-input
  4. Push & PR:
    git checkout -b feature/sick-idea
    git commit -m "Add sick idea"
    git push origin feature/sick-idea
  5. Open a Pull Request on GitHub

More details in our Contributing Guide!


⚖️ License

FastAPI Cookiecutter rocks the MIT License. Use it, tweak it, share it—just keep it chill and legal.


🌟 Show Your Support

  • ⭐ Star us on GitHub!
  • 🐛 Drop bugs or ideas in Issues.
  • 💬 Tell us how you’re using it—hit us up!

Pro Tip! 📢
Customize it your way. This is your FastAPI launchpad—make it fly!

Crafted with 🔥 by @Mohammad222PR.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published