{"id":19454260,"url":"https://github.com/light-hat/shop_service","last_synced_at":"2025-02-25T10:22:14.006Z","repository":{"id":260266156,"uuid":"880808724","full_name":"light-hat/shop_service","owner":"light-hat","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-05T09:02:32.000Z","size":7521,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-08T00:50:27.716Z","etag":null,"topics":["django","django-rest-framework","docker","postgresql"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/light-hat.png","metadata":{"files":{"readme":"Readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-30T12:00:02.000Z","updated_at":"2024-11-20T08:58:16.000Z","dependencies_parsed_at":"2024-10-30T13:35:45.529Z","dependency_job_id":null,"html_url":"https://github.com/light-hat/shop_service","commit_stats":null,"previous_names":["light-hat/shop_service"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/light-hat%2Fshop_service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/light-hat%2Fshop_service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/light-hat%2Fshop_service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/light-hat%2Fshop_service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/light-hat","download_url":"https://codeload.github.com/light-hat/shop_service/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240645903,"owners_count":19834506,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","django-rest-framework","docker","postgresql"],"created_at":"2024-11-10T17:08:52.536Z","updated_at":"2025-02-25T10:22:13.963Z","avatar_url":"https://github.com/light-hat.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e 🛒 Сервис магазинов \u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/light-hat/shop_service/actions\"\u003e\u003cimg alt=\"Unit test status\" src=\"https://img.shields.io/badge/Python-3.12-3776AB.svg?style=flat\u0026logo=python\u0026logoColor=white\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/light-hat/shop_service/actions\"\u003e\u003cimg alt=\"Unit test status\" src=\"https://github.com/light-hat/shop_service/workflows/Unit%20testing/badge.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/light-hat/shop_service/actions\"\u003e\u003cimg alt=\"Pylint status\" src=\"https://github.com/light-hat/shop_service/workflows/Pylint/badge.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/light-hat/shop_service/actions\"\u003e\u003cimg alt=\"Bandit SAST status\" src=\"https://github.com/light-hat/shop_service/workflows/SAST/badge.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/psf/black\"\u003e\u003cimg alt=\"Code style: black\" src=\"https://img.shields.io/badge/code%20style-black-000000.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n![Deploy](assets/docker_deploy.gif)\n\nТестовое задание на собеседование в Перспективный Мониторинг (дочерняя компания АО ИнфоТеКС).\n\n\n## 🔗 Зависимости\n\n| Зависимость         | Версия       |\n|---------------------|--------------|\n| Django              | `5.1.2`      |\n| djangorestframework | `3.15.2`     |\n| drf-spectacular     | `0.27.2`     |\n| psycopg2-binary     | `2.9.10`     |\n| gunicorn            | `23.0.0`     |\n\n\n## 📡 REST API\n\n![Swagger](assets/swagger.png)\n\nAPI задокументирован при помощи Swagger (`drf-spectacular`).\n\nТестирование API: `http://127.0.0.1/swagger/`\n\nYAML: `http://127.0.0.1/schema/`\n\n## 💾 База данных\n\n![ERD](assets/database.png)\n\nСвязи между сущностями (представлено на диаграмме):\n\n- Улица к городу: `многие к одному`;\n\n- Магазин к улице: `многие к одному`;\n\n- Магазин к городу: `многие к одному`.\n\nСУБД: `PostgreSQL 15 версии`.\n\nORM: `Django ORM`.\n\n## 👩‍💻 Админка Django\n\n![Admin](assets/admin.png)\n\n- Админка Django доступна по адресу `http://127.0.0.1/admin`.\n\n- Учётные данные для первого входа: `admin:admin`.\n\n\u003e [!IMPORTANT]\n\u003e Учётные данные рекомендуется сменить сразу после развёртывания на более устойчивые.\n\n- Также автоматически генерируются данные в БД сервиса для моделей города, улицы и магазина.\n\n- Автогенерация данных в сервиса автоматизирована с помощью кастомной команды:\n\n```shell\npython3 manage.py initdb\n```\n\nРеализовано тут: `api/management/commands/initdb.py`.\n\n\u003e [!TIP]\n\u003e После каждого перезапуска стека приложений база обогащается случайными данными.\n\n## ⚙️ Конфигурирование\n\nДля начала клонируйте репозиторий:\n\n```shell\ngit clone https://github.com/light-hat/shop_service\ncd shop_service\n```\n\nВ корне репозитория создайте `.env` файл со следующим содержимым:\n\n```\nAPI_URL=127.0.0.1\nAPI_PORT=80\nPOSTGRES_HOST=db\nPOSTGRES_PORT=5432\nPOSTGRES_USER=postgres\nPOSTGRES_PASSWORD=postgres\nPOSTGRES_DB=shop_database\n```\n\nПеременные окружения в конфигурации:\n\n- `API_URL`: адрес, на котором будет развёрнут сервис;\n\n- `API_PORT`: порт, на котором будет принимать запросы сервис;\n\n- `POSTGRES_HOST`: хост базы данных (имя сервиса в стеке приложений);\n\n- `POSTGRES_PORT`: порт базы данных;\n\n- `POSTGRES_USER`: пользователь базы данных;\n\n- `POSTGRES_PASSWORD`: пароль от базы данных;\n\n- `POSTGRES_DB`: имя базы данных, используемой сервисом.\n\n## 🚀 Запуск проекта\n\nДалее предлагается два варианта на выбор:\n\n\u003e [!NOTE]\n\u003e Сервис в обоих случаях будет доступен на `127.0.0.1:80`.\n\n### 1. Docker 🐋\n\n\u003e [!WARNING]  \n\u003e В системе должны быть установлены `Docker` и `Docker Compose`.\n\n```shell\ndocker-compose up -d --build\n```\n\n### 2. Vagrant ⭕\n\n\u003e [!WARNING]  \n\u003e Должны быть установлены `Vagrant` и `VirtualBox`.\n\n\u003e [!TIP]\n\u003e Базовый box `ubuntu/focal64` можно скачать [отсюда](https://portal.cloud.hashicorp.com/vagrant/discover/ubuntu/focal64).\n\n```shell\nvagrant up\n```\n\n## 🤖 Управление проектом через Make\n\n\u003e [!IMPORTANT]\n\u003e Для этого в системе должен быть установлен `Make`. При развёртывании через Vagrant, make устанавливается на виртуальную машину автоматически.\n\n\nДля автоматизации работы с docker-compose предлагается использование утилиты Make.\n\n- Сборка и запуск стека приложений:\n\n```shell\nmake build\n```\n\n- Запуск ранее собранного стека приложений:\n\n```shell\nmake up\n```\n\n- Остановка стека приложений:\n\n```shell\nmake down\n```\n\n- Перестроить стек приложений с удалением всех контейнеров и томов и без кеширования:\n\n```shell\nmake rebuild\n```\n\n- Очистить все контейнеры, сети и тома:\n\n```shell\nmake clean\n```\n\n- Вывести логи:\n\n```shell\nmake logs\n```\n\n- Автоформатирование через `black`:\n\n```shell\nmake black\n```\n\n- Проверить статус контейнеров:\n\n```shell\nmake status\n```\n\n## 🧪 Модульное тестирование\n\nНе успел уже =(\n\nСделано, но мало, только для модели Shop. Тестируется создание модели, сериализатор POST-запроса и вьюха фильтра магазинов.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flight-hat%2Fshop_service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flight-hat%2Fshop_service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flight-hat%2Fshop_service/lists"}