Merge branch 'main' of github.com:BesLogic/releaf-canopeum into fix-api

BesLogic · Mar 23, 2024 · 00e0059 · 00e0059
2 parents f031cca + 3f42ea4
commit 00e0059
Show file tree

Hide file tree

Showing 33 changed files with 1,485 additions and 1,008 deletions.
diff --git a/.github/workflows/canopeum_backend.yml b/.github/workflows/canopeum_backend.yml
@@ -54,3 +54,4 @@ jobs:
       - uses: jakebailey/pyright-action@v2
         with:
           python-version: "3.12"
+          working-directory: canopeum_backend
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -6,6 +6,7 @@
     "davidanson.vscode-markdownlint",
     "dbaeumer.vscode-eslint",
     "dprint.dprint",
+    "dotenv.dotenv-vscode",
     "eamodio.gitlens",
     "github.vscode-github-actions",
     "meganrogge.template-string-converter",
@@ -29,6 +30,8 @@
     "coenraads.bracket-pair-colorizer",
     "coenraads.bracket-pair-colorizer-2",
     "shardulm94.trailing-spaces",
+    // Use the official plugin instead
+    "mikestead.dotenv",
     // Lots of conflicts
     "esbenp.prettier-vscode",
     "rvest.vs-code-prettier-eslint",

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -1,23 +1,23 @@
 {
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Python Debugger: runserver",
-            "type": "debugpy",
-            "request": "launch",
-            "program": "canopeum_backend/manage.py",
-            "args": ["runserver"],
-            "console": "integratedTerminal"
-        },
-        {
-            "name": "Python Debugger: Current File",
-            "type": "debugpy",
-            "request": "launch",
-            "program": "${file}",
-            "console": "integratedTerminal"
-        }
-    ]
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Python Debugger: runserver",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "canopeum_backend/manage.py",
+      "args": ["runserver"],
+      "console": "integratedTerminal"
+    },
+    {
+      "name": "Python Debugger: Current File",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "${file}",
+      "console": "integratedTerminal"
+    }
+  ]
 }
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -8,9 +8,6 @@
       72
     ]
   },
-  "[markdown]": {
-    "files.trimTrailingWhitespace": false
-  },
   "files.trimTrailingWhitespace": true,
   "files.insertFinalNewline": true,
   "files.trimFinalNewlines": true,
@@ -52,7 +49,18 @@
   * CSS-specific settings
   */
   // TODO: Configure stylelint or dprint-prettier so I can recommend it
-  "[css][scss][postcss][less]": {
+  // NOTE: due to a bug in VSCode, we have to specify these individually to ensure it overrides user settings
+  // Please upvote: https://github.com/microsoft/vscode/issues/168411
+  "[css]": {
+    "editor.defaultFormatter": "vscode.css-language-features"
+  },
+  "[scss]": {
+    "editor.defaultFormatter": "vscode.css-language-features"
+  },
+  "[postcss]": {
+    "editor.defaultFormatter": "vscode.css-language-features"
+  },
+  "[less]": {
     "editor.defaultFormatter": "vscode.css-language-features"
   },
   "less.format.spaceAroundSelectorSeparator": true,
@@ -62,9 +70,34 @@
   * JavasScript-specific settings
   */
   // Set the default formatter to help avoid Prettier
-  "[json][jsonc][javascript][javascriptreact][typescript][typescriptreact][markdown][dockerfile]": {
+  // NOTE: due to a bug in VSCode, we have to specify these individually to ensure it overrides user settings
+  // Please upvote: https://github.com/microsoft/vscode/issues/168411
+  "[json]": {
+    "editor.defaultFormatter": "dprint.dprint"
+  },
+  "[jsonc]": {
     "editor.defaultFormatter": "dprint.dprint"
   },
+  "[javascript]": {
+    "editor.defaultFormatter": "dprint.dprint"
+  },
+  "[javascriptreact]": {
+    "editor.defaultFormatter": "dprint.dprint"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "dprint.dprint"
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "dprint.dprint"
+  },
+  "[markdown]": {
+    "files.trimTrailingWhitespace": false,
+    "editor.defaultFormatter": "dprint.dprint"
+  },
+  "[dockerfile]": {
+    "editor.defaultFormatter": "dprint.dprint"
+  },
+  "dprint.path": "canopeum_frontend/node_modules/dprint/dprint.exe",
   "typescript.tsdk": "canopeum_frontend/node_modules/typescript/lib",
   "typescript.enablePromptUseWorkspaceTsdk": true,
   "js/ts.implicitProjectConfig.checkJs": true,
@@ -156,8 +189,5 @@
   "evenBetterToml.formatter.reorderArrays": true,
   "evenBetterToml.formatter.trailingNewline": true,
   // We like keeping TOML keys in a certain non-alphabetical order that feels more natural
-  "evenBetterToml.formatter.reorderKeys": false,
-  "[typescriptreact]": {
-    "editor.defaultFormatter": "vscode.typescript-language-features"
-  }
+  "evenBetterToml.formatter.reorderKeys": false
 }
diff --git a/README.md b/README.md
@@ -34,7 +34,15 @@ For backend
    cd releaf-canopeum
    ```
 
-3. Set up a Python 3.12 virtual environment
+3. Install recommended Editor Extensions (for VSCode):\
+   When you first open the project in VSCode, you'll get a notification like this.\
+   ![Recommended Popup](/docs/Recommended_Popup.png)
+
+   If you've already dismissed this notification, you can search for `@recommended` in your Extensions tab.
+   Install everything under "**WORKSPACE RECOMMENDATIONS**", you can ignore "other recommendations":\
+   ![Recommended Extensions](/docs/Recommended_Extensions.png)
+
+4. Set up a Python 3.12 virtual environment
 
    ```shell
    cd canopeum_backend
@@ -64,7 +72,7 @@ For backend
    `CTRL+Shift+P` (Open Command Palette) > `Python: Select Interpreter`
    ![VSCode_select_venv](/docs/VSCode_select_venv.png)
 
-4. Set up Django backend and Database: (Skip this section for Frontend only)
+5. Set up Django backend and Database: (Skip this section for Frontend only)
 
    ```shell
    docker compose up
@@ -74,7 +82,7 @@ For backend
    python manage.py runserver
    ```
 
-5. Set up React frontend:
+6. Set up React frontend:
 
    ```shell
    cd canopeum_frontend

diff --git a/canopeum_backend/canopeum_backend/serializers.py b/canopeum_backend/canopeum_backend/serializers.py
@@ -59,7 +59,7 @@ class SiteTypeSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = Sitetype
-        fields = ["id", "en", "fr"]
+        fields = ("id", "en", "fr")
 
     def get_en(self, obj):
         return InternationalizationSerializer(obj.name).data.get("en", None)
@@ -74,7 +74,7 @@ class TreeTypeSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = Treetype
-        fields = ["en", "fr"]
+        fields = ("en", "fr")
 
     def get_en(self, obj):
         return InternationalizationSerializer(obj.name).data.get("en", None)
@@ -149,7 +149,7 @@ class BatchfertilizerSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = Batchfertilizer
-        fields = ["id", "en", "fr"]
+        fields = ("id", "en", "fr")
 
     def get_en(self, obj):
         return InternationalizationSerializer(obj.fertilizer_type).data.get("en", None)
@@ -164,7 +164,7 @@ class BatchMulchLayerSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = Mulchlayertype
-        fields = ["id", "en", "fr"]
+        fields = ("id", "en", "fr")
 
     def get_en(self, obj):
         return InternationalizationSerializer(obj.mulch_layer_type).data.get("en", None)
@@ -179,7 +179,7 @@ class BatchSupportedSpeciesSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = BatchSupportedSpecies
-        fields = ["en", "fr"]
+        fields = ("en", "fr")
 
     def get_en(self, obj):
         return InternationalizationSerializer(obj.tree_type).data.get("en", None)
@@ -194,7 +194,7 @@ class BatchSeedSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = BatchSeed
-        fields = ["quantity", "en", "fr"]
+        fields = ("quantity", "en", "fr")
 
     def get_en(self, obj):
         return InternationalizationSerializer(obj.tree_type).data.get("en", None)
@@ -209,7 +209,7 @@ class BatchSpeciesSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = BatchSpecies
-        fields = ["quantity", "en", "fr"]
+        fields = ("quantity", "en", "fr")
 
     def get_en(self, obj):
         return InternationalizationSerializer(obj.tree_type).data.get("en", None)

diff --git a/canopeum_backend/canopeum_backend/views.py b/canopeum_backend/canopeum_backend/views.py
@@ -1,5 +1,4 @@
-from typing import ClassVar
-
+from django.contrib.auth import authenticate
 from django.contrib.auth.models import User
 from drf_spectacular.utils import extend_schema
 from rest_framework import status
@@ -28,7 +27,7 @@
 
 
 class LoginAPIView(APIView):
-    permission_classes: ClassVar[list[type[AllowAny]]] = [AllowAny]
+    permission_classes = (AllowAny,)
 
     @extend_schema(request=AuthUserSerializer, responses=UserSerializer, operation_id="authentication_login")
     def post(self, request):
@@ -43,7 +42,7 @@ def post(self, request):
 
 
 class RegisterAPIView(APIView):
-    permission_classes: ClassVar[list[type[AllowAny]]] = [AllowAny]
+    permission_classes = (AllowAny,)
 
     @extend_schema(request=UserSerializer, responses=AuthUserSerializer, operation_id="authentication_register")
     def post(self, request):
@@ -189,10 +188,7 @@ def get(self, request):
 class PostListAPIView(APIView):
     @extend_schema(responses=PostSerializer(many=True), operation_id="post_all")
     def get(self, request):
-        try:
-            comment_count = Comment.objects.get(post=request.data.get("id")).count()
-        except Comment.DoesNotExist:
-            comment_count = 0
+        comment_count = Comment.objects.filter(post=request.data.get("id")).count()
         has_liked = 0
         siteId = request.GET.get("siteId", "")
         if siteId != "":

diff --git a/canopeum_backend/pyproject.toml b/canopeum_backend/pyproject.toml
@@ -71,10 +71,9 @@ ignore = [
   ### https://github.com/astral-sh/ruff/issues/1256 & https://github.com/astral-sh/ruff/issues/1774):
   "DJ001", # Avoid using `null=True` on string-based fields
   "DJ008", # Model does not define `__str__` method: https://docs.astral.sh/ruff/rules/django-model-without-dunder-str/
+  "N803", # Different naming convention between js/json and python. A better/configured middleware could take care of that
 ]
 
-[tool.ruff.format]
-
 # https://docs.astral.sh/ruff/settings/#flake8-implicit-str-concat
 [tool.ruff.lint.flake8-implicit-str-concat]
 allow-multiline = false
@@ -95,12 +94,6 @@ max-args = 7
 # At least same as max-complexity
 max-branches = 15
 
-# https://github.com/microsoft/pyright/blob/main/docs/configuration.md#sample-pyprojecttoml-file
-[tool.pyright]
-pythonVersion = "3.12"
-exclude = [".venv/"]
-typeCheckingMode = "standard"
-
 # https://mypy.readthedocs.io/en/stable/config_file.html
 [tool.mypy]
 show_column_numbers = true

diff --git a/canopeum_frontend/.eslintrc.cjs b/canopeum_frontend/.eslintrc.cjs
@@ -7,6 +7,7 @@ module.exports = {
     'beslogic/dprint',
   ],
   ignorePatterns: [
+    '.eslintrc.cjs',
     // Auto-generated
     'src/services/api.ts',
   ],
@@ -23,6 +24,5 @@ module.exports = {
     'no-autofix/no-relative-import-paths/no-relative-import-paths': 'off',
     // Using Bootraps directly without a React wrapper will cause us to have to add classes to React Components
     'react/forbid-component-props': 'off',
-    "react/display-name": [false, { "ignoreTranspilerName": false, "checkContextObjects": false }]
   },
 }
diff --git a/canopeum_frontend/index.html b/canopeum_frontend/index.html
@@ -17,6 +17,10 @@
     rel="stylesheet"
     href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,[email protected],100..700,0..1,-50..200"
   />
+  <link
+    href='https://unpkg.com/[email protected]/dist/maplibre-gl.css'
+    rel='stylesheet'
+  />
 </head>
 
 <body>