inital commit

README.md

@@ -1,3 +1,46 @@
-# booking_backend
+# WaterTrek Backend
 
-backend for the booking platform
+Skeleton Django backend for WaterTrek, using `uv` for package management and Docker for local development.
+
+## Stack
+
+- Django project: `WaterTrek`
+- First app: `booking`
+- Package manager: `uv`
+- Database: PostgreSQL (Docker service)
+
+## Run with Docker
+
+1. Optional: copy env defaults
+
+   ```bash
+   cp .env.example .env
+   ```
+
+2. Build and start:
+
+   ```bash
+   docker compose up --build
+   ```
+
+3. Visit the health endpoint:
+
+   - `http://localhost:8000/booking/health/`
+
+## Run locally with uv
+
+If your machine has internet access available for dependency install:
+
+```bash
+uv sync
+uv run python manage.py migrate
+uv run python manage.py runserver
+```
+
+## Production-style server in Docker
+
+The `web` container runs Gunicorn:
+
+```bash
+uv run gunicorn WaterTrek.wsgi:application --bind 0.0.0.0:8000 --workers 3
+```