Skip to content

Commit 4752ae0

Browse files
committed
Actual readme
1 parent e91c7af commit 4752ae0

2 files changed

Lines changed: 64 additions & 11 deletions

File tree

README.md

Lines changed: 64 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,19 +62,71 @@ SQLAlchemy, PostgreSQL и Celery с Redis.
6262
## 📂 Структура проекта
6363

6464
```
65-
ecommerce/
65+
FastAPI-Online-Shop/
66+
├── Dockerfile # Конфигурация Docker для контейнеризации приложения
67+
├── docker-compose.yml # Оркестрация сервисов (БД, кеш, воркеры)
68+
├── README.md # Документация проекта
69+
├── requirements.txt # Список зависимостей Python
70+
├── main.py # Точка входа FastAPI приложения
71+
├── conf_test_db.py # Настройки тестовой БД
72+
├── Vladelo Online Shop.png # Схематичное изображение проекта
6673
67-
├── auth/ # JWT и аутентификация
68-
├── cart/ # Модель и логика корзины
69-
├── orders/ # Обработка заказов + Celery
70-
├── products/ # Категории и продукты
71-
├── user/ # Модели и регистрация пользователя
72-
├── db.py # Подключение к базе данных
73-
├── config.py # Конфигурации проекта
74+
├── alembic/ # Миграции базы данных
75+
│ ├── env.py
76+
│ ├── script.py.mako
77+
│ └── versions/ # Файлы версий миграций
7478
75-
├── tests/ # Автоматические тесты
79+
├── ecommerce/ # Основной пакет приложения
80+
│ ├── __init__.py
81+
│ ├── config.py # Настройки проекта
82+
│ ├── db.py # Инициализация SQLAlchemy и подключение к БД
83+
│ │
84+
│ ├── auth/ # Аутентификация и авторизация
85+
│ │ ├── jwt.py # JWT-токены
86+
│ │ ├── router.py # Эндпоинты auth
87+
│ │ └── shema.py # Pydantic-схемы для auth
88+
│ │
89+
│ ├── user/ # Работа с пользователями
90+
│ │ ├── models.py
91+
│ │ ├── router.py
92+
│ │ ├── services.py # Логика работы с пользователями
93+
│ │ ├── hashing.py
94+
│ │ ├── validator.py
95+
│ │ └── shema.py
96+
│ │
97+
│ ├── products/ # Каталог товаров
98+
│ │ ├── models.py
99+
│ │ ├── router.py
100+
│ │ ├── services.py
101+
│ │ ├── validator.py
102+
│ │ └── shema.py
103+
│ │
104+
│ ├── cart/ # Корзина покупок
105+
│ │ ├── models.py
106+
│ │ ├── router.py
107+
│ │ ├── services.py
108+
│ │ └── shema.py
109+
│ │
110+
│ └── orders/ # Заказы
111+
│ ├── models.py
112+
│ ├── router.py
113+
│ ├── services.py
114+
│ ├── tasks.py # Асинхронные задачи (Celery)
115+
│ ├── worker.py # Воркеры для задач
116+
│ ├── mail.py # Отправка уведомлений
117+
│ └── shema.py
76118
77-
└── main.py # Точка входа FastAPI
119+
├── docs/ # Скриншоты и документация проекта
120+
121+
└── tests/ # Тесты приложения
122+
├── conftest.py # Общие фикстуры
123+
├── user/ # Тесты для пользователей
124+
├── products/ # Тесты для товаров
125+
├── cart/ # Тесты для корзины
126+
├── orders/ # Тесты для заказов
127+
├── login/ # Тесты логина
128+
├── registration/ # Тесты регистрации
129+
78130
```
79131

80132
## ⚙️ Установка и запуск
@@ -120,7 +172,8 @@ pytest
120172
## 📬 **Контакты**
121173

122174
Автор: Владислав Лахтионов
123-
GitHub: [vladelo777](https://github.com/vladelo777)
175+
GitHub: [vladelo-code](https://github.com/vladelo-code)
176+
Gitverse: [vladelo](https://gitverse.ru/vladelo/)
124177
Telegram: [@vladelo](https://t.me/vladelo)
125178

126179
💌 Не забудьте поставить звезду ⭐ на GitHub, если вам понравился проект! 😉

Vladelo Online Shop.png

2.74 MB
Loading

0 commit comments

Comments
 (0)