Dev

.flake8

@@ -0,0 +1,14 @@
+[flake8]
+max-line-length = 90
+extend-ignore = E501, E203, W503
+per-file-ignores =
+    settings*.py:E402,F403,F405
+exclude =
+    .git,
+    __pycache__,
+    .tox,
+    .eggs,
+    *.egg,
+    .venv,
+    venv,
+    .migrations

.github/workflows/main.yml

@@ -0,0 +1,33 @@
+name: Bookinn workflow
+
+on: [push]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+
+      - name: Install dependencies
+        run: |
+            python -m pip install --upgrade pip
+            pip install -r ./backend/requirements.txt
+
+      - name: Test with black (check only)
+        run: |
+          python -m black . --check
+
+      - name: Test with flake8-isort (check only)
+        run: |
+          python -m isort . --check-only
+
+      - name: Test with flake8
+        run: |
+          flake8 . --count --statistics --show-source

.gitignore

@@ -205,3 +205,8 @@ cython_debug/
 marimo/_static/
 marimo/_lsp/
 __marimo__/
+
+media/
+
+logs/
+*.log

README.md

@@ -1,2 +1,143 @@
-# bookinn
-Сервис бронирования номеров в отеле
+<a name="Начало"></a>
+
+## BookInn
+
+API сервис для бронирования номеров
+
+[![BookInn workflow](https://github.com/dmsnback/bookinn/actions/workflows/main.yml/badge.svg)](https://github.com/dmsnback/bookinn/actions/workflows/main.yml)
+
+
+- [Описание](#Описание)
+- [Технологии](#Технологии)
+- [Основные ресурсы](#Ресурсы)
+- [Шаблон заполнения .env-файла](#Шаблон)
+- [Запуск проекта на локальной машине](#Запуск)
+- [Автор](#Автор)
+
+<a name="Описание"></a>
+
+### Описание
+
+Сервис — REST API для бронирования номеров в отеле.  
+Реализован на Django + Django REST Framework, используется Djoser для аутентификации (JWT), drf-spectacular для документации.
+
+```python
+Проект адаптирован для использования PostgreSQL и развёртывания в контейнерах Docker.
+```
+
+> [Вернуться в начало](#Начало)
+<a name="Технологии"></a>
+
+### Технологии
+
+[![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)](https://www.python.org)
+![Django](https://img.shields.io/badge/django-%23092E20.svg?style=for-the-badge&logo=django&logoColor=white)
+[![DjangoREST](https://img.shields.io/badge/DJANGO-REST-ff1709?style=for-the-badge&logo=django&logoColor=white&color=ff1709&labelColor=gray)](https://www.django-rest-framework.org)
+[![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)](https://www.docker.com)
+[![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white)](https://www.postgresql.org)
+[![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)](https://github.com/features/actions)
+[![Nginx](https://img.shields.io/badge/nginx-%23009639.svg?style=for-the-badge&logo=nginx&logoColor=white)](https://nginx.org/ru/)
+[![Gunicorn](https://img.shields.io/badge/gunicorn-%298729.svg?style=for-the-badge&logo=gunicorn&logoColor=white)](https://gunicorn.org)
+
+> [Вернуться в начало](#Начало)
+
+<a name="Ресурсы"></a>
+
+### Основные ресурсы
+
+- `/api/v1/rooms/` — CRUD и список номеров
+- `/api/v1/room_type/` — типы номеров
+- `/api/v1/bookings/` — бронирования (создание/обновление/просмотр)
+- `/api/v1/room_images/` — загрузка фото номера
+- `/api/v1/auth/` — djoser (регистрация, логин, токены)
+
+> [Вернуться в начало](#Начало)
+
+<a name="Шаблон"></a>
+
+### Шаблон заполнения .env-файла, расположен по пути infra/.env
+
+> в settings.py указаны дефолтные значения для переменных из env-файла
+
+```python
+SECRET_KEY = 'Ваш секретный ключ'
+
+DB_ENGINE=django.db.backends.postgresql # указываем, что работаем с postgresql
+DB_NAME=postgres # имя базы данных
+POSTGRES_USER=postgres # логин для подключения к базе данных
+POSTGRES_PASSWORD=postgres # пароль для подключения к БД
+DB_HOST=db # название сервиса (контейнера)
+DB_PORT=5432 # порт для подключения к БД 
+```
+
+> [Вернуться в начало](#Начало)
+
+<a name="Запуск"></a>
+
+### Запуск проекта на локальной машине
+
+- Склонируйте репозиторий
+
+```python
+git clone git@github.com:dmsnback/bookinn.git
+```
+
+- Переходим в папку с файлом ```docker-compose.yaml```
+
+```python
+cd infra
+```
+
+- Запускаем Docker контейнеры
+
+```python
+docker-compose up -d --build
+```
+
+- Выполняем миграции
+
+```python
+docker-compose exec backend python manage.py migrate 
+```
+
+- Создаём суперюзера
+
+```python
+docker-compose exec backend python manage.py createsuperuser
+```
+
+- Собираем статику
+
+```python
+docker-compose exec backend python manage.py collectstatic --no-input
+```
+
+- Наполняем базу данных содержимым из файла ```rooms_fixture.json```:
+
+> В базу добавится 10 номеров.
+
+```python
+docker-compose exec backend python manage.py loaddata data/rooms_fixture.json
+```
+
+> __Проект станет доступен по адресу:__
+
+[http://localhost/api/v1/](http://localhost/api/v1/)
+
+> __Админка станет доступна по адресу:__
+
+[http://localhost/admin/](http://localhost/admin/)
+
+> __Документация к API будет доступна по адресу:__
+
+[http://localhost/api/docs/](http://localhost/api/docs/)
+
+> [Вернуться в начало](#Начало)
+
+<a name="Авторы"></a>
+
+### Автор
+
+- [Титенков Дмитрий](https://github.com/dmsnback)
+
+> [Вернуться в начало](#Начало)

backend/Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.11-slim
+LABEL maintainer="Dmitry Titenkov <lt200711@yandex.ru>"
+LABEL version="1.0"
+LABEL description="API for booking hotel rooms"
+RUN mkdir /app
+COPY  requirements.txt /app
+RUN pip3 install -r /app/requirements.txt --no-cache-dir -vvv
+COPY . /app
+WORKDIR /app
+CMD [ "gunicorn", "bookinn.wsgi:application", "--bind", "0.0.0.0:8000" ]

backend/api/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "api"

backend/api/urls.py

@@ -0,0 +1,8 @@
+from django.urls import include, path
+from drf_spectacular.views import SpectacularAPIView, SpectacularSwaggerView
+
+urlpatterns = [
+    path("v1/", include("api.v1.urls")),
+    path("schema/", SpectacularAPIView.as_view(), name="schema"),
+    path("docs/", SpectacularSwaggerView.as_view(url_name="schema"), name="docs"),
+]

backend/api/v1/pagination.py

@@ -0,0 +1,21 @@
+from rest_framework.pagination import PageNumberPagination
+from rest_framework.response import Response
+
+
+class CustomPagination(PageNumberPagination):
+    def get_paginated_response(self, data):
+        ordering = self.request.query_params.get("ordering", None)
+        return Response(
+            {
+                "links": {
+                    "next": self.get_next_link() or None,
+                    "previous": self.get_previous_link() or None,
+                },
+                "count": self.page.paginator.count,
+                "ordering": ordering,
+                "current_page": self.page.number,
+                "total_pages": self.page.paginator.num_pages,
+                "page_sizes": self.get_page_size(self.request),
+                "results": data,
+            }
+        )

backend/api/v1/permissions.py

@@ -0,0 +1,21 @@
+from rest_framework import permissions
+
+
+class IsOwnerOrAdmin(permissions.BasePermission):
+    """Разрешает доступ админу или владельцу бронирования."""
+
+    def has_object_permission(self, request, view, obj):
+        if request.user.is_staff or request.user.is_superuser:
+            return True
+        return obj.user == request.user
+
+
+class IsAdminOrReadOnly(permissions.BasePermission):
+    """Разрешаеет доступ админу с полными правами или юзеру только чтение."""
+
+    def has_permission(self, request, view):
+        return (
+            request.method in permissions.SAFE_METHODS
+            or request.user.is_staff
+            or request.user.is_superuser
+        )