fastapi-ignite - GitLite

KO | EN

gitlite — search

#javascript #python #react #typescript #llm #machine-learning #rust #linux #cli #kubernetes #vue #awesome-list #ios #openai

fastapi-ignite

(★ 150)

A production-ready FastAPI boilerplate application with a comprehensive set of features for modern web backend development.

File Explorer

Download Latest Version (.zip)

- - 001_initial.py
- env.py
- - logo-main.png
- cache.md
- cache_design.md
- - __init__.py
  - deps.py
- - __init__.py
  - decorators.py
  - dependencies.py
  - redis.py
- - __init__.py
  - config.py
  - events.py
  - exceptions.py
  - logging.py
- - __init__.py
  - base.py
  - session.py
- - __init__.py
  - jobs.py
  - scheduler.py
  - scheduler_runner.py
- - __init__.py
  - item.py
- - __init__.py
  - cached_item_service.py
  - item_service.py
- - __init__.py
  - jobs.py
  - worker.py
- - __init__.py
  - helpers.py
- __init__.py
- - __init__.py
- - __init__.py
  - test_backends.py
  - test_decorators.py
- - __init__.py
  - test_item_service.py
- - __init__.py
  - test_jobs.py
- __init__.py
- conftest.py
.env.example
.gitignore
alembic.ini
cli.py
DEVELOPER-GUIDE.md
docker-compose.yml
Dockerfile
LICENSE
main.py
README.md
requirements-dev.txt
requirements.txt

# Installation Guide

1. Get the code

git clone https://github.com/bakrianoo/fastapi-ignite

Downloads the entire project code from GitHub to your computer.

cd fastapi-ignite

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker-compose up -d

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Python

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

python -m venv venv

Runs the Python script (or module).

pip install -r requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

pip install -r requirements-dev.txt

Installs the Python libraries listed in requirements.txt (or similar).

✅ If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="/docs/assets/logo-main.png">
    <source media="(prefers-color-scheme: light)" srcset="/docs/assets/logo-main.png">
    <img alt="FastAPI-Ignite Boilerplate " src="/docs/assets/logo-main.png" width="158" height="326" style="max-width: 100%;">
  </picture>
  <br/>
</p>

<p align="center">
   <h2 align="center">FastAPI-Ignite Boilerplate </h2>
</p>

**FastAPI-Ignite** Boilerplate is a production-ready FastAPI boilerplate application with a comprehensive set of features for modern web backend development.

## Core Technologies

- **FastAPI**: High-performance async web framework for building APIs
- **SQLAlchemy**: SQL toolkit and ORM with async support
- **Pydantic v2**: Data validation and settings management using Python type hints
- **PostgreSQL**: Powerful open-source relational database
- **Redis**: In-memory data store for caching and message broker
- **Dramatiq**: Distributed task processing for background jobs
- **APScheduler**: Advanced Python scheduler for periodic tasks
- **Alembic**: Database migration tool

## Features

- ✅ **Modern Python codebase** using async/await syntax
- ✅ **Structured project layout** for maintainability
- ✅ **API versioning** to manage API evolution
- ✅ **Database integration** with async SQLAlchemy 2.0
- ✅ **Background task processing** with Dramatiq
- ✅ **Scheduled tasks** with APScheduler
- ✅ **Simple configuration** using environment variables
- ✅ **Comprehensive logging** with structured logs
- ✅ **Docker support** for easy deployment
- ✅ **Database migrations** with Alembic
- ✅ **Production-ready** with health checks, error handling, and more
- ✅ **Advanced caching** with multiple backends (Redis, File, Memory) at function and API endpoint levels

## Quick Start

1. Clone the repository:
   ```bash
   git clone https://github.com/bakrianoo/fastapi-ignite.git
   cd fastapi-ignite
   ```

2. Set up environment:
   ```bash
   # Copy the example .env file and edit with your configuration
   cp .env.example .env
   ```

### Start with Docker:
   ```bash
   docker-compose up -d
   ```

### Setting up locally

1. **Create a virtual environment**:
   ```bash
   python -m venv venv
   venv\Scripts\activate
   ```

2. **Install dependencies**:
   ```bash
   pip install -r requirements.txt
   pip install -r requirements-dev.txt
   ```

3. **Set up environment variables**:
   ```bash
   copy .env.example .env
   ```
   Edit the .env file with your configuration. All environment settings are now consolidated in this single file.

4. **Run database migrations**:
   ```bash
   alembic upgrade head
   ```

5. Start the API server
   ```bash
   python cli.py api --reload
   ```

6. Run database migrations
   ```bash
   python cli.py db migrate
   ```

7. Start the background worker
   ```bash
   python cli.py worker
   ```

8. Start the scheduler
   ```bash
   python cli.py scheduler
   ```

9. Access the API documentation:
   - Swagger UI: http://localhost:8000/api/docs
   - ReDoc: http://localhost:8000/api/redoc

## Development

See [DEVELOPER GUIDE](DEVELOPER-GUIDE.md) for detailed development information.

## License

This project is licensed under the MIT License - see the LICENSE file for details.