Merge pull request #11 from iosifnicolae2/main

feat: various improvements

Author: iosifnicolae2

.aider.conf.yml

@@ -0,0 +1 @@
+read: CONVENTIONS.md

.dockerignore

@@ -360,3 +360,4 @@ pyrightconfig.json
 !.env.local.example
 superapp_fork
 superapp/staticfiles
+!.aider.conf.yml

.gitignore

@@ -0,0 +1,125 @@
+Canvas Canvas
+You are an expert in Python, Django, scalable web development, and Django SuperApp structure.
+
+## Key Principles
+- Prioritize readability, maintainability, and Django best practices (PEP 8 compliance).
+- Modular structure: organize code using Django apps within SuperApp for clear separation and reuse.
+- Leverage built-in Django features; avoid raw SQL, prefer Django ORM.
+
+## Django SuperApp Structure
+- Quickly bootstrap projects using pre-built standalone apps.
+- Each app includes independent `settings.py` and `urls.py` automatically integrated by the SuperApp system.
+
+### App Settings Integration
+`superapp/apps/<app_name>/settings.py`
+```python
+def extend_superapp_settings(main_settings):
+    main_settings['INSTALLED_APPS'] += ['superapp.apps.sample_app']
+```
+
+### App URLs Integration
+`superapp/apps/<app_name>/urls.py`
+```python
+from django.urls import path
+from superapp.apps.sample_app.views import hello_world
+
+def extend_superapp_urlpatterns(main_urlpatterns):
+    main_urlpatterns += [path('hello_world/', hello_world)]
+```
+
+### App-Specific Requirements
+Each app can define its own Python dependencies in:
+`superapp/apps/<app_name>/requirements.txt`
+
+These requirements should be installed during deployment or development setup if the app is used. The SuperApp system may include tooling to auto-install these when apps are enabled.
+
+## Django Guidelines
+- Use CBVs for complex logic, FBVs for simple tasks.
+- Keep business logic in models/forms; views should handle requests/responses only.
+- Utilize built-in authentication and forms/models validation.
+- Follow strict MVT separation.
+- Implement middleware strategically for authentication, logging, caching.
+- Error handling via built-in mechanisms; customize error pages.
+- Leverage signals for decoupled logging/error handling.
+- Do not update migrations in the `migrations` folder. Update migrations only if there are exceptions or issues inside of it.
+
+## Admin Integration
+
+### Use `django-unfold` and SuperApp admin site with Sidebar Navigation
+
+- Admins must live in: `superapp/apps/<app_name>/admin/<model_name_slug>.py`
+- Models must live in: `superapp/apps/<app_name>/models/<model_name_slug>.py`
+- Signals must live in: `superapp/apps/<app_name>/signals/<model_name_slug>.py`
+- Services must live in: `superapp/apps/<app_name>/services/<service_name>.py`
+- Views must live in: `superapp/apps/<app_name>/views/<view_name>.py`
+- Tasks must live in: `superapp/apps/<app_name>/tasks/<task_name>.py`
+- Other things must live in: `superapp/apps/<app_name>/<other>/<view_name>.py`
+- Usually each of the above folders will have an `__init__.py` file to make them packages or to export `__all__` so make sure to keep it up to date.
+- Register using `superapp_admin_site` from `superapp.apps.admin_portal.sites`
+- Use `SuperAppModelAdmin` based on `unfold.admin.ModelAdmin`
+- Prefer `autocomplete_fields` for `ForeignKey` and `ManyToManyField`
+
+### Add Admin Navigation
+
+Each app should configure sidebar entries under `UNFOLD['SIDEBAR']['navigation']` in its `settings.py`.
+
+Example:
+```python
+from django.utils.translation import gettext_lazy as _
+from django.urls import reverse_lazy
+
+def extend_superapp_settings(main_settings):
+    main_settings['INSTALLED_APPS'] += ['superapp.apps.sample_app']
+
+    main_settings['UNFOLD']['SIDEBAR']['navigation'] = [
+        {
+            "title": _("Sample App"),
+            "icon": "extension",
+            "items": [
+                {
+                    "title": lambda request: _("Sample Models"),
+                    "icon": "table_rows",
+                    "link": reverse_lazy("admin:sample_app_samplemodel_changelist"),
+                    "permission": lambda request: request.user.has_perm("sample_app.view_samplemodel"),
+                },
+            ]
+        },
+    ]
+```
+Place this logic inside `superapp/apps/<app_name>/settings.py` within `extend_superapp_settings()`.
+
+Example: `superapp/apps/sample_app/admin/sample_model.py`
+```python
+from superapp.apps.admin_portal.admin import SuperAppModelAdmin
+from superapp.apps.admin_portal.sites import superapp_admin_site
+from .models import SampleModel
+
+@admin.register(SampleModel, site=superapp_admin_site)
+class SampleModelAdmin(SuperAppModelAdmin):
+    list_display = ['slug', 'name', 'created_at', 'updated_at']
+    search_fields = ['name__slug', 'slug']
+    autocomplete_fields = ['name']
+```
+
+## Dependencies
+- Django
+- Django REST Framework (APIs)
+- Celery (background tasks)
+- Redis (caching/task queues)
+- PostgreSQL/MySQL (production databases)
+- django-unfold (admin UI)
+
+## Performance & Security
+- Optimize ORM queries (`select_related`, `prefetch_related`).
+- Use caching framework (Redis/Memcached).
+- Apply async views/background tasks (Celery).
+- Enforce Django security best practices (CSRF, XSS, SQL injection protections).
+
+## Translation Convention
+- Add translation items explicitly in `AppTranslations` from `backend/superapp/apps/easywindow/enums.py`.
+
+Follow Django and SuperApp documentation for detailed practices.
+
+## Environment Variables
+Use `.env.local.example` and `.env.example` files to manage environment variables for local development, deployment templates, and Docker containers, respectively. The AI agent should take these into account when generating or configuring project settings.
+

CONVENTIONS.md

@@ -22,47 +22,72 @@ setup-sample-env:
 	cp .env.local.example .env.local;
 	cp .env.example .env;
 
+web-bash:
+	docker-compose exec -ti web bash
+
+web-logs:
+	docker-compose logs -f web -n 1000
 
 start-docker:
 	docker-compose up -d --build
 
+force-start-docker:
+	docker-compose up -d --build --force-recreate
+
 stop-docker:
 	docker-compose stop
 
 destroy-docker:
 	docker-compose stop
 	docker-compose down -v
 
-migrate:
-	python3 manage.py migrate
-
 makemigrations:
-	python3 manage.py makemigrations
+	docker-compose run web python3 manage.py makemigrations
+
+migrate:
+	docker-compose run web python3 manage.py migrate
 
 createsuperuser:
-	python3 manage.py createsuperuser
+	docker-compose run web python3 manage.py createsuperuser
 
 collectstatic:
-	python3 manage.py collectstatic --no-input
+	docker-compose exec web python3 manage.py collectstatic --no-input
 
 start-tailwind-watch:
 	cd superapp/apps/admin_portal/tailwind; \
 	npm run tailwind:watch
 
+list_all_permissions:
+	docker-compose exec web python3 manage.py list_all_permissions
+
+list_all_urls_patterns:
+	docker-compose exec web python3 manage.py list_all_urls_patterns
 
 makemessages:
 	mkdir -p site-packages
-	ln -s /usr/local/lib/python33.11/site-packages/unfold site-packages/unfold
-	ln -s /usr/local/lib/python33.11/site-packages/django site-packages/django
-	python3 manage.py makemessages -l de -l en -i venv -s
-	rm -r site-packages
+	ln -s venv/lib/python3.13/site-packages/unfold site-packages/unfold
+	ln -s venv/lib/python3.13/site-packages/django site-packages/django
+	docker-compose exec web python3 manage.py makemessages -l ro -l en -i venv -s
+	rm -rf site-packages
 
 compilemessages:
-	python3 manage.py compilemessages
+	docker-compose exec web python3 manage.py compilemessages
+	rm -rf site-packages
+
+generate_django_translations:
+	docker-compose exec web python3 manage.py generate_django_translations
+
+generate_material_variant_prices:
+	docker-compose exec web python3 manage.py generate_material_variant_prices
+
+generate_translation_values:
+	docker-compose exec web python3 manage.py generate_translation_values
 
 
 create-fixtures:
-	python3 manage.py dumpdata --natural-foreign --natural-primary --indent 2 --output fixtures/initial_data.json
+	docker-compose exec web python3 manage.py dumpdata --natural-foreign --natural-primary --indent 2 --output fixtures/fixtures.json
 
 load-fixtures:
-	python3 manage.py loaddata fixtures/initial_data.json
+	docker-compose exec web python3 manage.py loaddata \
+		fixtures/fixtures
+

Makefile

@@ -1,7 +1,10 @@
-Django==5.0.*
-gunicorn==22.0.*
-whitenoise==6.7.*
-django-debug-toolbar==4.3.*
-dj-database-url==2.1.0
+Django==5.1.*
+gunicorn==23.0.*
+whitenoise==6.9.*
+django-debug-toolbar==5.0.*
+dj-database-url==2.3.*
 django_superapp==1.*
-redis==5.0.*
+redis==5.2.*
+django-storages[s3]==1.14.*
+boto3==1.37.*
+beautifulsoup4==4.12.*

requirements.txt

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -e;
+
+python manage.py migrate
+
+python manage.py collectstatic --noinput

scripts/run-migrations.sh

@@ -1,8 +1,7 @@
 #!/bin/bash
 set -e;
 
-python manage.py collectstatic --noinput
-python manage.py migrate
+#python manage.py migrate
 
 # Check the DEBUG environment variable
 if [ "$DEBUG" = "true" ] || [ "$DEBUG" = "1" ] || [ "$DEBUG" = "t" ]; then

scripts/run-server.sh

@@ -10,3 +10,4 @@ else
     # Run the celery worker
     celery -A superapp worker --loglevel=INFO --beat --scheduler django_celery_beat.schedulers:DatabaseScheduler --concurrency=5
 fi
+