1. О чем проект:

Проект Artele — это телеграмм-бот созданный для продажи различных товаров. Все действия происходят через бота, который взаимодействует с API написанным на DRF.

API покрыто тестами на 80%. Настроен github actions с проверкой PEP8 и pytest, а также выгрузкой в docker hub

2. Функции:

Со стороны пользователей:

• Регистрация пользователей при запуске бота
• Подача заявки на доступ к оформлению заказов
• Добавление товаров в корзину
• Оформление заказа
• Редактирование корзины и отмена заказа

Со стороны администратора:

• Добавление и редактирование новых товаров
• Удаление товаров
• Управление заявками от пользователей
• Оповещение пользователей (определенного или всех)
• Фильтрация оформленных заказов по пользователям или по товарам
• Отметки о выполненных или отмененных заказах
• Загрузка списка оформленных заказов в формате pdf

В планах:

• функция закрытия\открытия общего доступа к оформлению заказов
• оформление документации
• рефакторинг api
• автоматический деплой на сервер

3. Стек:

• Python 3.9
• Django 4.2.2
• Django REST Framework 3.14.0
• Aiogram 3.0.0b7

3. Автор:

Никита Федоров (github: https://github.com/oupsfed)

4. Как запустить локально:

Клонировать репозиторий и перейти в него в командной строке:

git@github.com:oupsfed/artele.git

cd artele

Настроить .env файл

TOKEN=Токен бота
URL=http://web:8000/
URL_DEV=http://127.0.0.1:8000/
DB_ENGINE=django.db.backends.postgresql
POSTGRES_DB=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
DB_HOST=db
DB_PORT=5432

Установить docker и запустить контейнеры командой:

docker-compose up -d

Для ознакомления с работой api перейдите на http://localhost:8000/redoc/

Приятного пользования!