Cleanpro 🧹

Ваш самый дружелюбный и красивый web-сервис по оформлению и управлению заказами на уборку*

^{* по версии нашей бэкенд-команды}

---

ССЫЛКИ

Главная страница (develop версия)

API документация

Figma

---

ВВЕДЕНИЕ

CleanPRO - это веб-приложение, которое поможет вашей клининговой компании полностью автоматизировать оформление входящих заявок на уборку. Управляющему персоналу доступен удобный и информативный личный кабинет администратора, который в реальном времени позволяет отслеживать заказы и их статистику. Пользователям предлагается современный и практичный интерфейс создания заявки, спроектированный на основании результатов социального опроса десятков людей.

---

ОПИСАНИЕ

Миссия CleanPRO - предоставить максимально удобный и доступный сервис как для заказчиков, так и для клининговой компании.

Для клиентов:

• ⚡️ быстрое оформление заказа без первичной регистрации
• 💷 прозрачность ценообразования
• 🕑 интерактивный выбор графика уборки
• 🔄 возможность повтора заказов в несколько кликов
• 🫶 интуитивно-понятный интерфейс

Для администраторов:

• 🚦 автоматическое оформление заказа и присвоение заказу уборщика без участие человека
• ⛪️ удобный личный кабинет с полным доступом ко всем заказам и персоналу
• 📊 емкая статистика заказов, охватывающая каждый их аспект от наиболее используемых услуг до самой частой причины отмен
• 📅 управление графиком работы уборщиков, в т.ч. отпуском
• 🌎 автоматическая загрузка отзывов с Я.Карт на сайт

---

ТЕХНОЛОГИИ

CleanPRO разработан с использованием следующих технологий:

• Python (v.3.11) - целевой язык программирования backend
• Django (v.4.2) - высокоуровневый веб-фреймворк
• Django REST framework (v.3.14) - инструмент для создания Web API
• PostgreSQL (v.13.10) - объектно-реляционная база данных
• Celery (v.5.3) - распределенная очередь задач
• Redis (v.5.0) - резидентная система управления NoSQL базами данных, брокер сообщений Celery
• PyJWT (v.2.8) - плагин, предоставляющий JSON Web Token аутентификацию для Django REST Framework, разработанную в соответствии со стандартом RFC 7519
• Gunicorn (v.21.2) - Python WSGI HTTP-сервер для UNIX
• Nginx - HTTP-сервер и обратный прокси-сервер
• Docker (v.24.0) - инструмент для автоматизирования процессов разработки, доставки и запуска приложений в контейнерах

• JavaScript (v.1.8) - целевой язык программирования frontend
• React (v.18.2) - библиотека JavaScript для разработки пользовательских интерфейсов (UI) веб-приложений
• React Router (v.6.15) - библиотека React для маршрутизации страниц
• Vite (v.4.4) - инструмент сборки JavaScript-приложений
• Redux (v.8.1) - библиотека управления состоянием JavaScript приложений
• SCSS - метаязык написания CSS-кода

---

РАЗВЕРТКА

✅ Создать корневую папку с проектом (предлагается "cleanpro") и перейти в неё

mkdir cleanpro
cd cleanpro

✅ Загрузить актуальные версии frontend и backend

git clone git@github.com:Clean-PRO/frontend.git
git clone git@github.com:Clean-PRO/backend.git

✅ Перейти в папку backend

cd backend/backend

✅ Создать файл переменных окружения из примера

cp .env.example .env

✅ Изменить переменные окружения (если необходимо)

(на примере редактора Nano)
nano .env

✅ Перейти в корневую папку backend

cd ..

✅ Запустить Docker (убедитесь, что docker daemon запущен в системе!)

docker-compose up --build

✅ Проверить доступность проекта на localhost:80

http://localhost:80/

---

ЛИЦЕНЗИЯ

MIT

Ура, халява!

---

КОМАНДА BACKEND

🦸🏻‍♂️ Кирилл

🧙🏻‍♀️ Виктор

🥷 Владимир

🧚‍♀️ Регина