First release (#33)

Co-authored-by: root <root@Legion.localdomain>
Co-authored-by: Osama Yasser <osamayasserr@gmail.com>

Author: 3 people

.envs/.local/.django

@@ -2,6 +2,7 @@
 # ------------------------------------------------------------------------------
 USE_DOCKER=yes
 IPYTHONDIR=/app/.ipython
+
 # Redis
 # ------------------------------------------------------------------------------
 REDIS_URL=redis://redis:6379/0
@@ -12,3 +13,11 @@ REDIS_URL=redis://redis:6379/0
 # Flower
 CELERY_FLOWER_USER=debug
 CELERY_FLOWER_PASSWORD=debug
+
+# Files
+# ------------------------------------------------------------------------------
+FILE_UPLOAD_STORAGE=local
+
+# Firebase
+# ------------------------------------------------------------------------------
+GOOGLE_APPLICATION_CREDENTIALS=/home/$USER/google-services.json

.github/workflows/ci.yml

@@ -7,11 +7,11 @@ env:
 
 on:
   pull_request:
-    branches: [ "master", "main" ]
+    branches: [ "master", "main", "dev"]
     paths-ignore: [ "docs/**" ]
 
   push:
-    branches: [ "master", "main" ]
+    branches: [ "master", "main", "dev"]
     paths-ignore: [ "docs/**" ]
 
 concurrency:

.gitignore

@@ -277,3 +277,9 @@ api/media/
 .env
 .envs/*
 !.envs/.local/
+
+# VScode
+.vscode
+
+# Media files
+media

Makefile

@@ -53,4 +53,4 @@ destroy:
 
 
 rm_pyc:
-	find . -name '__pycache__' -name '*.pyc' | xargs rm -rf
+	find . -name '__pycache__' -name '*.pyc' | xargs rm -rf

api/apis/__init__.py

@@ -0,0 +1 @@
+# Init

api/apis/apps.py

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

api/apis/migrations/__init__.py

@@ -0,0 +1 @@
+# Init

api/apis/pagination.py

@@ -0,0 +1,55 @@
+from collections import OrderedDict
+
+from rest_framework.pagination import LimitOffsetPagination as _LimitOffsetPagination
+from rest_framework.response import Response
+
+
+def get_paginated_response(
+    *, pagination_class, serializer_class, queryset, request, view
+):
+    paginator = pagination_class()
+
+    page = paginator.paginate_queryset(queryset, request, view=view)
+
+    if page is not None:
+        serializer = serializer_class(page, many=True)
+        return paginator.get_paginated_response(serializer.data)
+
+    serializer = serializer_class(queryset, many=True)
+
+    return Response(data=serializer.data)
+
+
+class LimitOffsetPagination(_LimitOffsetPagination):
+    default_limit = 10
+    max_limit = 50
+
+    def get_paginated_data(self, data):
+        return OrderedDict(
+            [
+                ("limit", self.limit),
+                ("offset", self.offset),
+                ("count", self.count),
+                ("next", self.get_next_link()),
+                ("previous", self.get_previous_link()),
+                ("results", data),
+            ]
+        )
+
+    def get_paginated_response(self, data):
+        """
+        We redefine this method in order to return `limit` and `offset`.
+        This is used by the frontend to construct the pagination itself.
+        """
+        return Response(
+            OrderedDict(
+                [
+                    ("limit", self.limit),
+                    ("offset", self.offset),
+                    ("count", self.count),
+                    ("next", self.get_next_link()),
+                    ("previous", self.get_previous_link()),
+                    ("results", data),
+                ]
+            )
+        )

api/apis/tests.py

@@ -0,0 +1 @@
+# Tests

api/apis/urls.py

@@ -0,0 +1,11 @@
+from django.urls import include, path
+
+app_name = "apis"
+urlpatterns = [
+    path("auth/", include("api.authentication.urls", "authentication")),
+    path("users/", include("api.users.urls", "users")),
+    path("cases/", include("api.cases.urls", "cases")),
+    path("files/", include("api.files.urls", "files")),
+    path("notifications/", include("api.notifications.urls", "notifications")),
+    path("locations/", include("api.locations.urls", "locations")),
+]