Сервіс створення чеків

Налаштування проекту

Нам потрібно налаштувати програму для правильної роботи.

Встановити змінні середовища

Щоб безпечно взаємодіяти з проектом, нам потрібно додати кілька змінних середовищ у файл .env.

• DB_NAME
• DB_USER
• DB_PASSWORD
• PGADMIN_DEFAULT_EMAIL
• PGADMIN_DEFAULT_PASSWORD
• WK_HOST
• WK_PORT

Потрібні ключі можна знайти у автора проекту.

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

Для запуску проекту вам необхідно встановити docker, після чого написати команду у командному рядку у папці проекту

docker build .
docker-compose run --rm app sh -c "python manage.py makemigrations"
docker-compose up --build

Відкрийте http://localhost:8000, щоб переглянути його проект у браузері.

Команда docker-compose up --build запускає проект із міграцією. Усі необхідні залежності проекту прописані у файлі requirements.txt.

Документація з API

Повну документацію проекту можна переглянути запустивши проект і перейти на http://localhost:8000/api/docs/. URL відкриє документацію у Swagger UI.

Основні кінцеві точки проекту

Основні endpoints по проекту з методами GET, POST, PUT, PATCH та DELETE

• http://127.0.0.1:8000/api/docs/ - документація проекту

Кінцеві точки для чека

• http://127.0.0.1:8000/receipt/checks/ - для перегляду списку чеків та створення нового чека
  
• http://127.0.0.1:8000/receipt/checks/{id}/ - для перегляду деталі чека, оновлення даних або видалення
• http://127.0.0.1:8000/receipt/checks/create_pdf/ - POST запит, для створення нового чека із замовлення
• http://127.0.0.1:8000/receipt/checks/{printer_id}/download/ - для завантаження всіх чеків pdf формату для принтера у zip файлі

Кінцеві точки для принтера

• http://127.0.0.1:8000/receipt/printers/ - для перегляду списку принерів та створення нового принтера
  
• http://127.0.0.1:8000/receipt/printers/{id} - для перегляду деталей принтера, оновлення даних або видалення

Додаткові кінцеві точки

• http://127.0.0.1:8000/admin/ - сторінка адміну
• http://127.0.0.1:5050/ - сервер pgadmin