{"id":22308283,"url":"https://github.com/pavelpatsey/inside_test_task","last_synced_at":"2026-05-02T15:32:38.492Z","repository":{"id":140764444,"uuid":"531454927","full_name":"PavelPatsey/inside_test_task","owner":"PavelPatsey","description":"API на основе Django REST Framework. Реализация тестового задания на позицию Junior Developer","archived":false,"fork":false,"pushed_at":"2022-11-23T11:51:30.000Z","size":116,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T22:49:45.855Z","etag":null,"topics":["django-rest-framework","docker-compose","python3"],"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/PavelPatsey.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":"2022-09-01T09:44:09.000Z","updated_at":"2022-11-23T11:51:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"3f0fe79c-72d9-482d-8342-4aa5dee2b99a","html_url":"https://github.com/PavelPatsey/inside_test_task","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PavelPatsey%2Finside_test_task","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PavelPatsey%2Finside_test_task/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PavelPatsey%2Finside_test_task/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PavelPatsey%2Finside_test_task/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PavelPatsey","download_url":"https://codeload.github.com/PavelPatsey/inside_test_task/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245570777,"owners_count":20637224,"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-rest-framework","docker-compose","python3"],"created_at":"2024-12-03T20:13:31.566Z","updated_at":"2026-05-02T15:32:38.453Z","avatar_url":"https://github.com/PavelPatsey.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Проект inside_test_task\n\n![inside_test_task workflow](https://github.com/PavelPatsey/inside_test_task/actions/workflows/main.yml/badge.svg)\n\nAPI на основе Django REST Framework. Реализация тестового задания на позицию Junior Developer. Описание задания находится по адресу ./Junior_Developer_task_description.txt, можно посмотреть по [ссылке](https://github.com/PavelPatsey/inside_test_task/blob/main/Junior_Developer_task_description.txt).\n\n## Стек технологий\n\n- проект написан на Python с использованием Django REST Framework;\n- база данных - PostgreSQL;\n- система управления версиями - git;\n- [Docker](https://docs.docker.com/engine/install/ubuntu/), [Dockerfile](https://docs.docker.com/engine/reference/builder/), [Docker Compose](https://docs.docker.com/compose/).\n\n## Решение с запуском только контейнера с проектом:\n[ветка Dockerfile](https://github.com/PavelPatsey/inside_test_task/tree/feature/docker_only)\n\n## Реализовано\n- Кастомная JWT аутентификация.\n- Требуемые в задании POST эндпоинты.\n- GitHub Actions:\n    - Проверка кода на соответствие PEP8 и выполнение тестов, реализованных в проекте.\n     - Сборка и публикация образа приложения на DockerHub.\n\n## Образ Docker\nОбраз Docker находится в репозитории по адресу:\nhttps://hub.docker.com/repository/docker/pavelpatsey/inside_project\n\n## Запуск проекта в Docker Compose:\n\n1. Склонируйте репозиторий.\n2. В каталоге ./infra создайте файл .env c аналогичной структурой:\n ```\nDB_ENGINE=django.db.backends.postgresql # указываем, что работаем с postgresql\nDB_NAME=postgres # имя базы данных\nPOSTGRES_USER=postgres # логин для подключения к базе данных\nPOSTGRES_PASSWORD=password_postgres # пароль для подключения к БД (установите свой)\nDB_HOST=db # название сервиса (контейнера)\nDB_PORT=5432 # порт для подключения к БД\nSECRET_KEY=django_secret_key # секретный ключ django (установите свой)\n ```\n3. В командной строке перейдите в папку ./infra, запустите docker-compose в фоновом режиме командой:\n```\ndocker-compose up -d\n```\n4. Примените миграции:\n```\ndocker-compose exec backend python manage.py migrate\n\n```\n5. Чтобы зайти в админку создайте суперпользователя:\n```\ndocker-compose exec backend python manage.py createsuperuser\n\n```\nТеперь проект доступен по адресу http://localhost/api/messages/\n\nАдминка доступна по адресу http://localhost/admin/\n\n6. Чтобы протестировать работу приложения заполните БД тестовыми данными:\n\n```\ndocker-compose exec backend python3 manage.py fill_database_with_test_data\n```\n\n## Curl\nФайл с примерами запросов находится по адресу ./curl_commands, можно посмотреть по [ссылке](https://github.com/PavelPatsey/inside_test_task/blob/main/curl_commands). Должны быть установлены curl и jq, если нет:\n```\napt install curl\napt install jq\n```\n## Endpoints:\n\n### Аутентификация пользователя.\n`http://localhost:8000/api/auth/token/`\\\nPOST запрос с телом вида:\n```json\n{\n  \"name\": \"имя отправителя\",\n  \"password\": \"пароль\"\n}\n```\nВ случае удачной аутентификации возвращает JWT токен:\n```json\n{\n  \"token\": \"xxxxx.xxxx.xxxx\"\n}\n```\n### Заголовок Authorization.\nФормат заголовка \"Authorization\" должен быть таким:\\\n\"Bearer_token\"\n\n### Отправка сообщения или запрос истории. \n`http://localhost:8000/api/messages/`\\\nPOST запрос с телом вида:\n```json\n{\n  \"name\": \"имя отправителя\",\n  \"message\": \"новое сообщение\"\n}\n```\nВ ответ получает:\n```json\n{\n  \"name\": \"имя отправителя\",\n  \"message\": \"новое сообщение\"\n}\n```\nВ случае, если отправлен POST запрос вида:\n```json\n{\n  \"name\": \"user_name\",\n  \"message\": \"history n\"\n}\n```\nгде n - целое неотрицательное число, возвращает последние n из БД.\nНапример, если n равно 5 в ответ получает:\n```json\n[\n    {\"name\": \"имя отправителя\", \"message\": \"новое сообщение\"},\n    {\"name\": \"имя отправителя\", \"message\": \"test message text 14\"},\n    {\"name\": \"имя отправителя\", \"message\": \"test message text 13\"},\n    {\"name\": \"имя отправителя\", \"message\": \"test message text 12\"},\n    {\"name\": \"имя отправителя\", \"message\": \"test message text 11\"},\n]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpavelpatsey%2Finside_test_task","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpavelpatsey%2Finside_test_task","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpavelpatsey%2Finside_test_task/lists"}