README.md

📌 Каталог организаций (FastAPI + PostgreSQL)

Этот проект — REST API сервис для хранения и управления каталогом организаций.
Стек технологий: FastAPI, SQLAlchemy, Alembic, PostgreSQL, Docker.

🚀 Запуск проекта

1. Клонируем репозиторий

git clone https://github.com/Sleeeepy7/fastapi-org.git
cd fastapi-org

2. Создаём файл переменных окружения

Создайте .env файл и укажите в нём:

POSTGRES_USER=your_user
POSTGRES_PASSWORD=your_password
POSTGRES_DB=db_name
APP_CONFIG__DB__URL=postgresql+asyncpg://${POSTGRES_USER}:${POSTGRES_PASSWORD}@db:5432/${POSTGRES_DB} # руками ничего подставлять не надо

3. Запускаем сервис

docker-compose up --build

⏳ Подождите, пока создадутся контейнеры. После старта API будет доступен по адресу:
🔗 http://localhost:8000/docs (Swagger UI)

---

❌ Остановка контейнеров

Чтобы остановить контейнеры, используйте команду:

docker-compose down

🔄 Полный сброс (удаление БД)

Если нужно полностью сбросить базу данных, используйте:

docker-compose down -v

⚠️ Внимание! После этой команды данные в БД удалятся безвозвратно.

---

📜 Документация

Полное описание задания находится в файле ТЗ