fix(dev): Resolve Dev Debug Environment Issues and Streamline Local Setup

This commit comprehensively addresses issues with the local development and debugging environment, ensuring a smoother and more reliable developer experience.

Key changes include:

- **VSCode Debugger:** Corrected launch configuration (`.vscode/launch.json`) to properly run the Django development server with debugging enabled. It now correctly sets `DEBUG=True`, uses `0.0.0.0:8000`, and specifies the correct working directory.
- **Docker Compose:** Exposed the PostgreSQL port (`5432:5432`) in `docker-compose.yml` to allow direct connections from the host, facilitating local development and debugging without needing to run the full application stack.
- **Environment Variables:**
    - Updated `.gitignore` to ignore all `.env.*` files, allowing for environment-specific configurations.
    - Modified `src/pkmntrade_club/django_project/settings.py` to use `localhost` for `DJANGO_DATABASE_URL` and `REDIS_URL` by default, aligning with the exposed Docker services for easier local development. Default `DISABLE_SIGNUPS` and `DISABLE_CACHE` are now `True` for a more typical local dev setup.
- **Management Commands & Scripts:**
    - Adjusted `manage.py` to correctly append the project's root directory to `sys.path`, resolving potential import issues when running management commands.
    - Significantly improved `scripts/reset-db_make-migrations_seed-data.sh`:
        - Removed reliance on sourcing `.env` directly.
        - Ensured the database service (`db`) is started independently before migrations.
        - Added explicit steps for running `prebuild.sh`, migrations, and `collectstatic`.
        - Switched to using `uv run manage.py loaddata` for seeding, which is more consistent with the project's tooling.
- **Django Settings:** Added `SESSION_ENGINE = "django.contrib.sessions.backends.signed_cookies"` and `SESSION_COOKIE_HTTPONLY = True` for improved session management and security.

These changes collectively fix the previously problematic development setup, enabling straightforward debugging and a more efficient workflow for local development.
This commit is contained in:
badblocks 2025-06-01 19:05:56 -07:00
parent 4af7512293
commit 48ea0eb48e
No known key found for this signature in database
6 changed files with 29 additions and 17 deletions

View file

@ -4,22 +4,23 @@ set -e
echo "Remaking migrations..."
find . -path "*/migrations/0*.py" -delete
set -a
source .env
set +a
uv run manage.py makemigrations --noinput
echo "Resetting dev database... "
docker compose down \
&& docker volume rm -f pkmntradeclub_postgres_data \
&& ./scripts/rebuild-and-run.sh
&& docker compose up -d db
echo "Running prebuild..."
./scripts/prebuild.sh
echo "Running migrations..."
uv run manage.py migrate --noinput
# Wait for the database to be ready.
echo "Waiting 15 seconds for migrations to be auto-run..."
sleep 15
echo "Loading seed data..."
docker compose exec -it web bash -c "django-admin loaddata /seed/0*"
uv run manage.py loaddata ./seed/0*
docker compose down
echo "Running collectstatic..."
uv run manage.py collectstatic -c --no-input
echo "Done!"