feat: simplified backend api project structure

unfoldadmin · Dec 29, 2024 · edc1852 · edc1852
1 parent 4248080
commit edc1852
Show file tree

Hide file tree

Showing 17 changed files with 31 additions and 31 deletions.
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -10,7 +10,7 @@
     {
       "label": "Create superuser",
       "type": "shell",
-      "command": "docker compose exec api uv run -- python src/manage.py createsuperuser",
+      "command": "docker compose exec api uv run -- python manage.py createsuperuser",
       "isBackground": false
     }
   ]

diff --git a/README.md b/README.md
@@ -168,7 +168,7 @@ openssl rand -base64 32
 There are two ways how to create new user account in the backend. First option is to run managed command responsible for creating superuser. It is more or less required, if you want to have an access to the Django admin. After running the command below, it will be possible to log in on the front end part of the application.
 
 ```bash
-docker compose exec api uv run -- python src/manage.py createsuperuser
+docker compose exec api uv run -- python manage.py createsuperuser
 ```
 
 The second option how to create new user account is to register it on the front end. Turbo provides simple registration form. After account registration, it will be not possible to log in because account is inactive. Superuser needs to access Django admin and activate an account. This is a default behavior provided by Turbo, implementation of special way of account activation is currently out the scope of the project.

diff --git a/backend/src/backend/__init__.py → backend/api/__init__.py b/backend/src/backend/__init__.py → backend/api/__init__.py
diff --git a/backend/src/backend/admin.py → backend/api/admin.py b/backend/src/backend/admin.py → backend/api/admin.py
diff --git a/backend/src/backend/api.py → backend/api/api.py b/backend/src/backend/api.py → backend/api/api.py
diff --git a/backend/src/backend/asgi.py → backend/api/asgi.py b/backend/src/backend/asgi.py → backend/api/asgi.py
@@ -2,6 +2,6 @@
 
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "backend.settings")
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "api.settings")
 
 application = get_asgi_application()
diff --git a/...nd/src/backend/migrations/0001_initial.py → backend/api/migrations/0001_initial.py b/...nd/src/backend/migrations/0001_initial.py → backend/api/migrations/0001_initial.py
diff --git a/backend/src/backend/migrations/__init__.py → backend/api/migrations/__init__.py b/backend/src/backend/migrations/__init__.py → backend/api/migrations/__init__.py
diff --git a/backend/src/backend/models.py → backend/api/models.py b/backend/src/backend/models.py → backend/api/models.py
diff --git a/backend/src/backend/serializers.py → backend/api/serializers.py b/backend/src/backend/serializers.py → backend/api/serializers.py
diff --git a/backend/src/backend/settings.py → backend/api/settings.py b/backend/src/backend/settings.py → backend/api/settings.py
@@ -16,9 +16,9 @@
 
 ALLOWED_HOSTS = ["localhost", "api"]
 
-WSGI_APPLICATION = "backend.wsgi.application"
+WSGI_APPLICATION = "api.wsgi.application"
 
-ROOT_URLCONF = "backend.urls"
+ROOT_URLCONF = "api.urls"
 
 DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"
 
@@ -36,7 +36,7 @@
     "rest_framework",
     "rest_framework_simplejwt",
     "drf_spectacular",
-    "backend",
+    "api",
 ]
 
 ######################################################################
@@ -91,7 +91,7 @@
 ######################################################################
 # Authentication
 ######################################################################
-AUTH_USER_MODEL = "backend.User"
+AUTH_USER_MODEL = "api.User"
 
 AUTH_PASSWORD_VALIDATORS = [
     {
@@ -157,7 +157,7 @@
                     {
                         "title": _("Users"),
                         "icon": "person",
-                        "link": reverse_lazy("admin:backend_user_changelist"),
+                        "link": reverse_lazy("admin:api_user_changelist"),
                     },
                     {
                         "title": _("Groups"),

diff --git a/backend/src/backend/urls.py → backend/api/urls.py b/backend/src/backend/urls.py → backend/api/urls.py
diff --git a/backend/src/backend/wsgi.py → backend/api/wsgi.py b/backend/src/backend/wsgi.py → backend/api/wsgi.py
@@ -2,6 +2,6 @@
 
 from django.core.wsgi import get_wsgi_application
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "backend.settings")
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "api.settings")
 
 application = get_wsgi_application()
diff --git a/backend/src/manage.py → backend/manage.py b/backend/src/manage.py → backend/manage.py
@@ -7,7 +7,7 @@
 
 def main():
     """Run administrative tasks."""
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "backend.settings")
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "api.settings")
     try:
         from django.core.management import execute_from_command_line
     except ImportError as exc:

diff --git a/backend/pyproject.toml b/backend/pyproject.toml
@@ -1,5 +1,5 @@
 [project]
-name = "backend"
+name = "api"
 requires-python = ">=3.13"
 version = "0.1.0"
 dependencies = [

diff --git a/backend/uv.lock b/backend/uv.lock
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -16,7 +16,7 @@ services:
       timeout: 2s
       retries: 10
   api:
-    command: bash -c "uv sync && uv run -- python src/manage.py migrate && uv run -- python src/manage.py runserver 0.0.0.0:8000"
+    command: bash -c "uv sync && uv run -- python manage.py migrate && uv run -- python manage.py runserver 0.0.0.0:8000"
     build:
       context: backend
     expose: