https://github.com/macalistervadim/fastapi-blog

API online platform for creating, maintaining and viewing user blogs
https://github.com/macalistervadim/fastapi-blog

alembic docker fastapi rest-api sqlalchemy

Last synced: about 2 months ago
JSON representation

API online platform for creating, maintaining and viewing user blogs

• Host: GitHub
• URL: https://github.com/macalistervadim/fastapi-blog
• Owner: macalistervadim
• License: mit
• Created: 2025-04-18T09:22:52.000Z (about 1 year ago)
• Default Branch: dev
• Last Pushed: 2025-05-19T05:59:57.000Z (about 1 year ago)
• Last Synced: 2025-05-19T06:34:50.989Z (about 1 year ago)
• Topics: alembic, docker, fastapi, rest-api, sqlalchemy
• Language: Python
• Homepage: http://macalistervadim.site
• Size: 134 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 🚀 FastAPI Blog

[![Python](https://img.shields.io/badge/Python-3.13-blue.svg)](https://www.python.org/)

[![FastAPI](https://img.shields.io/badge/FastAPI-0.115.12-green.svg)](https://fastapi.tiangolo.com/)

[![Docker](https://img.shields.io/badge/Docker-ready-blue.svg)](https://www.docker.com/)

[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

---

Проект для создания личных блогов с использованием современного стека технологий.

## 🛠️ Технологический стек

### Основные технологии

- **Python 3.13+**: Современная версия языка программирования

- **FastAPI 0.115+**: Высокопроизводительный веб-фреймворк для создания API

- **SQLAlchemy 2.0+**: ORM для работы с базами данных

- **Pydantic**: Валидация данных и сериализация

- **PostgreSQL**: Основная база данных (через asyncpg)

### Инструменты разработки

- **Docker & Docker Compose**: Контейнеризация и оркестрация

- **Alembic**: Миграции базы данных

- **pytest**: Тестирование

- **ruff**: Линтер и форматер кода

- **mypy**: Статический анализатор типов

- **pre-commit**: Автоматизация проверок перед коммитом

## 🏗️ Архитектура проекта

Проект следует принципам чистой архитектуры:

- Роутеры (API endpoints)

- Сервисный слой (бизнес-логика)

- Репозитории (работа с БД)

- Модели данных (SQLAlchemy)

- Схемы (Pydantic)

## 📦 Быстрый старт

1. **Клонирование репозитория:**

```bash

git clone https://github.com/macalistervadim/fastapi-blog

cd fastapi-blog

```

2. **Настройка окружения:**

```bash

cp .env.example .env.local

```

3. **Запуск проекта:**

```bash

docker-compose -f docker-compose.local.yml up -d

```

4. **Создание миграций:**

```bash

docker-compose -f docker-compose.local.yml exec web alembic revision --autogenerate -m "Initial migration"

```

   

5. **Применение миграций:**

```bash

docker-compose -f docker-compose.local.yml exec web alembic upgrade head

```

   

6. **Проверка работоспособности:**

Откройте браузер и перейдите по адресу [http://localhost:8000/docs](http://localhost:8000/docs) для доступа к Swagger UI.

P.S - Данная инструкция предусматривает, что вы опытный пользователь используемых в проекте инструментов и не включает в себя подробные шаги по установке и настройке Docker, Docker Compose, виртуального окружения и других инструментов. Если у вас возникли трудности, пожалуйста, обратитесь к официальной документации.

## 🧪 Тестирование

Для запуска тестов используйте команду:

```bash

docker-compose -f docker-compose.local.yml exec web pytest

```

## 📜 Лицензия

Этот проект лицензирован под MIT License. Пожалуйста, ознакомьтесь с файлом [LICENSE](LICENSE) для получения подробной информации.

## 📫 Контакты

Вопросы и предложения принимаются в [issue](https://github.com/macalistervadim/fastapi-blog/issues)