chore(core): merge dev into main (#187)

.github/workflows/main.yml

@@ -5,7 +5,6 @@ on:
   pull_request:
     branches:
       - none
-
   push:
     branches:
       - main
@@ -31,11 +30,11 @@ jobs:
         run: docker build . --file Dockerfile --tag $BRANCH_NAME
 
       - name: Log into registry
-        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login docker.pkg.github.com -u ${{ github.actor }} --password-stdin
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin
 
       - name: Push image
         run: |
-          IMAGE_ID=docker.pkg.github.com/${{ github.repository }}/$BRANCH_NAME
+          IMAGE_ID=ghcr.io/${{ github.repository }}/$BRANCH_NAME
           # Change all uppercase to lowercase
           IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
           # Strip git ref prefix from version

.pre-commit-config.yaml

@@ -1,3 +1,4 @@
+default_install_hook_types: [pre-commit, commit-msg]
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
@@ -17,6 +18,7 @@ repos:
     rev: 5.12.0
     hooks:
       - id: isort
+        args: ["--profile", "black", "--filter-files"]
 
   - repo: https://github.com/psf/black
     rev: 23.3.0

CONTRIBUTING.md

@@ -20,10 +20,21 @@ If you already have experience with django/wagtail, understanding the backend wi
 
 ----
 # Env Setup
+- ### Docker
+  - Create a Python Virtual Environment and activate it
+  - Install the pre-commit hooks by running `pre-commit install --install-hooks`
+  - Make sure You have **docker** installed and the `cd` to `bfportal` directory
+  - Copy the `.env.template` file to `.env`
+  - Create a [discord application](https://discord.com/developers/applications) for OAuth2 and copy the client id and secret
+  - Paste the client id and secret in `.env` file to `DISCORD_CLIENT_ID` and `DISCORD_SECRET` respectively
+  - Then run `docker-compose --profile dev_local up`
+  - The website should be available at `127.0.0.1:8000`
+  - If You want to set up everything your self, See the next points
+
 
 - ### Python
     -  Refer to [readme.md](/readme.md#how-to-run-locally)
-    -  install pre-commit checks by runnning (**make sure the Virtual Enviroment is activated !!**)
+    -  install pre-commit checks by running (**make sure the Virtual Enviroment is activated !!**)
         ```
         pre-commit install
         ```
@@ -41,7 +52,10 @@ If you already have experience with django/wagtail, understanding the backend wi
         ```
         python manage.py tailwind start
         ```
-
+- ### Postgres
+    - Make sure postgres is installed and running
+    - Create DB, USER and Password for the project
+    - Update the `.env` file accordingly
 
 ----
 
@@ -76,9 +90,9 @@ bfportal/
 - Make sure all the precommit test are passed
 - Open a pull request to merge the branch into dev branch
 - The changes will be reviewed on dev deployment
-- Upon successfull testing dev will be merged into main
+- Upon successfully testing dev will be merged into main
 
 # How to discuss with the maintainers
-- Join our [discord server](https://bfportal.gg/join).
+- Join our [discord server](https://discord.bfportal.gg/).
 - Open a new issue.
 - mail us at [email protected]

bfportal/.env.template

@@ -1,21 +1,22 @@
-POSTGRES_HOST=
-DB_NAME=
-DB_USERNAME=
-DB_PASSWORD=
-
-SU_PASSWD=
-PRODUCTION_KEY=
-PRODUCTION_HOST=
-PRODUCTION_PORT=
-
+SU_PASSWD=1234
+PRODUCTION_KEY=%dn0n58@4z7j(5=o(i1w-24-d2n7elvvu3hawh)$8d^^cfg40-
+PRODUCTION_HOST=127.0.0.1
+ALLAUTH_PROTOCOL=HTTP
+OWNERS=236802771381125120,338947895665360898,216307162106822659
+PRODUCTION_PORT=8000
+DEBUG=True
+DB_NAME=postgres
+DB_USERNAME=postgres
+DB_PASSWORD=postgres
+# required for login via discord Oauth
 DISCORD_CLIENT_ID=
 DISCORD_SECRET=
 
+# Not required unless You want to the featues to publish updates to discord
+DISCORD_BOT_TOKEN=#required to get scheduled events of a server
+
 APPROVAL_CHANNEL_WEBHOOK_TOKEN=
 APPROVAL_CHANNEL_WEBHOOK_ID=
 
 APPROVAL_SUCCESS_CHANNEL_WEBHOOK_TOKEN=
 APPROVAL_SUCCESS_CHANNEL_WEBHOOK_ID=
-
-ALLAUTH_PROTOCOL=
-OWNERS=

bfportal/Dockerfile

@@ -1,5 +1,5 @@
 # Use an official Python runtime based on Debian 10 "buster" as a parent image.
-FROM python:3.11-slim-buster
+FROM python:3.11-slim-buster as dev
 
 # Add user that will be used in the container.
 RUN useradd --create-home wagtail
@@ -59,6 +59,8 @@ COPY --chown=wagtail:wagtail . .
 # Use user "wagtail" to run the build commands below and the server itself.
 USER wagtail
 
+FROM dev as final
+
 RUN python manage.py tailwind install --no-input;
 RUN python manage.py tailwind build --no-input
 RUN python manage.py collectstatic --noinput --clear

bfportal/bfportal/settings/base.py

@@ -28,7 +28,7 @@
 INSTALLED_APPS = [
     "whitenoise.runserver_nostatic",
     "core",
-    "factory",
+    "wagtail",
     "wagtail.contrib.forms",
     "wagtail.contrib.redirects",
     "wagtail.embeds",
@@ -39,7 +39,6 @@
     "wagtail.images",
     "wagtail.search",
     "wagtail.admin",
-    "wagtail.core",
     "wagtail.contrib.routable_page",
     "wagtail.api.v2",
     "wagtail_color_panel",

bfportal/bfportal/settings/dev.py

@@ -8,7 +8,6 @@
 
 # SECURITY WARNING: define the correct hosts in production!
 ALLOWED_HOSTS = ["*"]
-
 EMAIL_BACKEND = "django.core.mail.backends.console.EmailBackend"
 
 

bfportal/bfportal/urls.py

@@ -11,8 +11,8 @@
 from django.contrib import admin
 from django.urls import include, path, re_path
 from django.views.generic import RedirectView, TemplateView
+from wagtail import urls as wagtail_urls
 from wagtail.admin import urls as wagtailadmin_urls
-from wagtail.core import urls as wagtail_urls
 from wagtail.documents import urls as wagtaildocs_urls
 from wagtailautocomplete.urls.admin import urlpatterns as autocomplete_admin_urls
 

bfportal/bfportal/wsgi.py

@@ -27,10 +27,10 @@ def init_wsgi():
     with warnings.catch_warnings():
         os.environ.setdefault("DJANGO_SETTINGS_MODULE", "bfportal.settings.production")
         from django.core.wsgi import get_wsgi_application
-        from wagtail.utils.deprecation import RemovedInWagtail50Warning
+        from wagtail.utils.deprecation import RemovedInWagtail60Warning
 
         warnings.filterwarnings(
-            "ignore", category=RemovedInWagtail50Warning
+            "ignore", category=RemovedInWagtail60Warning
         )  # supress only wagtail warnings
         application = get_wsgi_application()
 

bfportal/core/admin.py

@@ -1 +1,6 @@
+from django.contrib import admin
+
+from .models.users import Profile
+
+admin.site.register(Profile)
 # Register your models here.

bfportal/core/helper.py

@@ -16,7 +16,7 @@
 
 def get_scheduled_events(event_id: str, server_id: str = "870246147455877181") -> dict:
     """Tries to retrieve Scheduled events via discord API"""
-    if DISCORD_TOKEN := os.getenv("DISCORD_BOT_TOKEN", None):
+    if len(DISCORD_TOKEN := os.getenv("DISCORD_BOT_TOKEN", "")):
         headers = {
             "Authorization": f"Bot {DISCORD_TOKEN}",
             "content-type": "application/json",
@@ -26,6 +26,10 @@ def get_scheduled_events(event_id: str, server_id: str = "870246147455877181") -
             headers=headers,
         )
         return resp.json()
+    else:
+        logger.warning(
+            "Unable to get scheduled events... DISCORD_BOT_TOKEN not provided"
+        )
 
 
 def validate_image_link(link: str):

bfportal/core/management/commands/ensure_initialization.py

@@ -10,7 +10,7 @@
 from django.contrib.auth.models import User
 from django.core.management.base import BaseCommand
 from loguru import logger
-from wagtail.core.models import Page, Site
+from wagtail.models import Page, Site
 
 
 class Command(BaseCommand):

bfportal/core/management/commands/import_db.py

@@ -51,7 +51,6 @@ def handle(self, *args, **options):  # noqa: D102
             json_db = json.load(db_file)
         su = User.objects.filter(is_superuser=True).first()
         for json_row in json_db:
-
             row = DBRow(**json_row)
             if row.type == "Prefabs":
                 row.type = "Prefab"