README.md

Cozinha de Campos project

Project created using Copier tool.

Tools, libs, etc. Some time related files.

Versions on pyproject.lock.

• AlpineJS JavaScript Framework based on Vue engine
• Django Web framework written in Python
• django-allauth Authentication and social account login for Django
• django-environ Manage .envs in Django
• django-extensions Add manage commands to the django and more
• django-htmx Django + HTMX integration
• Docker Manage containers for dev environment
  • compose.yaml
  • compose/dev/Dockerfile
  • compose/dev/start
  • .env
• Gunicorn Python WSGI HTTP Server for UNIX
• HTMX htmx gives access to AJAX, CSS Transitions, WebSockets and Server Sent Events directly from HTML
• Just Encapsulate commands for easier use
  • justfile
• psycopg Python adapter for Postgres
• Python Programming language
• Sentry Error tracking and performance monitoring
• TailwindCSS CSS Framework
• Uv Python packaging and dependency management
  • uv.lock
  • pyproject.toml
• WhiteNoise Simplified static file serving for Python web apps
• Xonsh Python-powered shel

...and development

• django-browser-reload Auto reload the browser when change a template
• Marimo Notebook for test, prototype, inspections, etc.
  • extras/template.py - Template for a new notebook.
• Pytest Tools for testing.
• Pytest-django Pytest Plugin for Django
• ruff Linter and code formatter

Dev environment setup

1. Install Just, Docker and uv (optional). Certify that docker is up and running
2. Copy .env.example to .env, no need for an edition.
3. $ just build
4. $ just mng createsuperuser

Run the server for development

1. Ensure that docker is up and running
2. $ just up

You can access the Django app on http://0.0.0.0:8000/ and Marimo notebook on http://0.0.0.0:2718/

On production

add to the .env:

ALLOWED_HOSTS=www.cozinhadecampos.com.br CSRF_TRUSTED_ORIGINS=https://www.cozinhadecampos.com.br