brian/baby-monitor
1
0
Fork 0
Code Issues 3 Pull Requests 1 Actions Packages Projects Releases 12 Wiki Activity

prettier fixes

Browse Source
This commit is contained in:
Brian Bjarke Jensen
2025-11-06 23:37:55 +01:00
parent f15e87a484
commit c2d272d7ac
1 changed files with 22 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -5
View File
@@ -37,7 +37,7 @@ open http://localhost:8000
### Using Docker Compose ### Using Docker Compose
```yaml ```yaml
version: '3.8' version: "3.8"
services: services:
baby-monitor: baby-monitor:
@@ -84,27 +84,30 @@ uv run uvicorn src.baby_monitor.main:app --reload --host 0.0.0.0 --port 8000
### Environment Variables ### Environment Variables
| Variable | Default | Description | | Variable | Default | Description |
|----------|---------|-------------| | ---------------- | ------------ | ------------------------------------------- |
| `ENVIRONMENT` | `production` | Set to `development` to enable API docs | | `ENVIRONMENT` | `production` | Set to `development` to enable API docs |
| `ADMIN_PASSWORD` | *(required)* | Admin user password | | `ADMIN_PASSWORD` | _(required)_ | Admin user password |
| `ADMIN_USERNAME` | `admin` | Admin username | | `ADMIN_USERNAME` | `admin` | Admin username |
| `DATA_DIR` | `/data` | Directory for SQLite database | | `DATA_DIR` | `/data` | Directory for SQLite database |
| `REDIS_URI` | *(optional)* | Redis connection URI for distributed tokens | | `REDIS_URI` | _(optional)_ | Redis connection URI for distributed tokens |
### Storage Options ### Storage Options
**SQLite (Default)** **SQLite (Default)**
- Automatic setup, no configuration needed - Automatic setup, no configuration needed
- Data stored in `/data/baby_monitor.db` - Data stored in `/data/baby_monitor.db`
- Perfect for single-server deployments - Perfect for single-server deployments
**Redis (Optional)** **Redis (Optional)**
```bash ```bash
# Enable Redis token storage # Enable Redis token storage
export REDIS_URI=redis://localhost:6379 export REDIS_URI=redis://localhost:6379
``` ```
**PostgreSQL (Future)** **PostgreSQL (Future)**
- Repository interface ready - Repository interface ready
- Swap implementation in `dependencies.py` - Swap implementation in `dependencies.py`
@@ -190,6 +193,7 @@ uv run pytest tests/integration/
### Docker Swarm / Kubernetes ### Docker Swarm / Kubernetes
The application is stateless when using Redis for tokens, making it suitable for: The application is stateless when using Redis for tokens, making it suitable for:
- Multi-replica deployments - Multi-replica deployments
- Load balancing - Load balancing
- Rolling updates - Rolling updates
@@ -197,6 +201,7 @@ The application is stateless when using Redis for tokens, making it suitable for
### CI/CD ### CI/CD
Gitea Actions workflow included: Gitea Actions workflow included:
- Builds multi-architecture images (amd64, arm64) - Builds multi-architecture images (amd64, arm64)
- Automatic semantic versioning - Automatic semantic versioning
- Pushes to container registry - Pushes to container registry
@@ -213,7 +218,7 @@ When running in development mode (`ENVIRONMENT=development`):
### Key Endpoints ### Key Endpoints
| Endpoint | Method | Description | | Endpoint | Method | Description |
|----------|--------|-------------| | ------------- | ------ | ---------------------- |
| `/` | GET | Serve home page | | `/` | GET | Serve home page |
| `/api/` | GET | Authenticated API root | | `/api/` | GET | Authenticated API root |
| `/api/login` | POST | User authentication | | `/api/login` | POST | User authentication |