🚀 Starter-Template

A modern Python FastAPI starter template with built-in support for testing, linting, type checking, Docker, and CI. Includes Poetry for dependency management, pre-commit hooks for code quality, and GitHub Actions for continuous integration — ready to clone and build APIs, microservices, or full-stack apps.

---

🧰 Tech Stack

• FastAPI — Web framework
• Poetry — Dependency and package manager
• Docker — Containerization
• GitHub Actions — CI/CD pipeline
• pytest — Testing framework
• pre-commit — Code linting automation

---

📦 Installation

Install project dependencies and run the app locally with hot reload:

poetry install
poetry run uvicorn starter-template.main:app --reload

---

🧪 Run Tests

poetry run pytest

---

🧹 Format & Lint (pre-commit)

Set up and run pre-commit hooks:

poetry run pre-commit install
poetry run pre-commit run --all-files

---

🐳 Docker Usage

Build and run the app with Docker:

docker build -t starter-template .
docker run -p 8000:8000 starter-template

---

✅ Continuous Integration

This project uses GitHub Actions to automatically run tests and lint checks on every push:

---

📁 Project Structure

myapp/
├── myapp/                  # Application package
│   └── main.py             # FastAPI app
├── tests/                  # Pytest tests
│   └── test_smoke.py
├── pyproject.toml          # Poetry config
├── .pre-commit-config.yaml # Linting hooks
├── .github/workflows/ci.yml# GitHub Actions workflow
├── Dockerfile              # Docker image definition
├── README.md               # Project documentation
└── .gitignore

---