Приложение для создания заметок

Описание

REST API приложение для создания заметок пользователями с авторизацией через JWT.

Возможности

• Управление пользователями: Регистрация, просмотр списка пользователей и авторизация.
• Управление заметками: Полный CRUD (просмотр, создание, удаление, полное и частичное обновление заметки).
• Безопасность: Доступ к заметкам имеют только их владельцы. Хранение паролей в зашифрованном виде.
• Документация: Интерактивное тестирование всех эндпоинтов через Swagger UI.

Технологии

• Fast API — веб-фреймворк.
• SQLAlchemy 2.0 (ORM)
• PostgreSQL — база данных
• Docker && Docker Compose — контейнеризация приложения и СУБД

Установка и настройка

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

   git clone https://github.com/JustChelUser/fastapi_notes.git
   

2. Создайте .env файл по образцу .env.example и укажите в нём конфигурационные данные. Либо оставьте тестовые данные для первого запуска.
3. Сборка и запуск :

   docker compose up -d
   

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

После запуска приложение и интерактивная документация доступны по адресу: http://localhost:8000/docs (Swagger UI)

Для тестирования эндпоинтов заметок зарегистрируйте пользователя, нажмите кнопку Authorize (зеленый замочек) вверху страницы и введите логин/пароль.