docs(260618-smr): remove Redis references from documentation and e2e config
- CLAUDE.md: remove Redis constraint, ioredis library row, Redis architecture sentence, update compose comment - README.md: remove Redis from prereqs, quick-start command, compose description, tech-stack live-sync row - docs/ARCHITECTURE.md: delete Redis infrastructure table row - docs/CONFIGURATION.md: remove Redis localhost:6379 mention from dev section - docs/deployment.md: delete redis services table row - docs/DEVELOPMENT.md: remove prereq mention, heading, two up commands, expose bullet, stack comment - docs/GETTING-STARTED.md: prereq row, up command, prose mention - docs/TESTING.md: 'API and MariaDB' (was API, MariaDB, and Redis) - apps/pwa/e2e/README.md: delete Redis on :6379 bullet - apps/pwa/playwright.config.ts: two comments updated (API+MariaDB, not API+MariaDB+Redis)
This commit is contained in:
Lucas Berger
@@ -248,7 +248,6 @@ routes/setup.ts ──→ db (app_config)
|
||||
| Local auth storage | scrypt PHC hash in `local_credentials.password_hash`; session signed with `LOCAL_SESSION_SECRET` env var |
|
||||
| Push notifications | `web-push` (VAPID) → APNs (iOS) / FCM (Android) |
|
||||
| Live list sync | In-process Node.js `EventEmitter` → SSE (`text/event-stream`) |
|
||||
| Redis | Present in stack (image: `redis:7-alpine`); not used in current runtime (reserved for future multi-process pub/sub) |
|
||||
| PWA | React 19 + Vite 8 + `vite-plugin-pwa` (Workbox `injectManifest` mode) |
|
||||
| Networking | Pangolin/Newt tunnel — no open ports; split-DNS internal domain |
|
||||
| Deployment | Docker Compose on Unraid; single `api` container serves both the API and the PWA static build |
|
||||
|
||||
@@ -163,7 +163,7 @@ VAPID_SUBJECT=mailto:admin@example.com
|
||||
|
||||
### Local Development (host-side)
|
||||
|
||||
The dev Docker Compose override (`docker-compose.dev.yml`) exposes MariaDB on `localhost:3306` and Redis on `localhost:6379`. To run the API and PWA directly on the host:
|
||||
The dev Docker Compose override (`docker-compose.dev.yml`) exposes MariaDB on `localhost:3306`. To run the API and PWA directly on the host:
|
||||
|
||||
```bash
|
||||
# Build the API first (dev script runs compiled output)
|
||||
|
||||
+6
-7
@@ -35,7 +35,7 @@ src/
|
||||
|
||||
- **Node.js 22 LTS** — the Dockerfile base is `node:22-alpine`; match this locally
|
||||
- **pnpm 11.5.1** — managed via corepack (`corepack enable pnpm`)
|
||||
- **Docker + Docker Compose** — for MariaDB and Redis in dev
|
||||
- **Docker + Docker Compose** — for MariaDB in dev
|
||||
- **TypeScript 5.x** — installed per-workspace as a dev dependency
|
||||
|
||||
## Local Setup
|
||||
@@ -48,13 +48,13 @@ pnpm install
|
||||
|
||||
This installs all workspace packages (`apps/api` and `apps/pwa`) in a single pass.
|
||||
|
||||
### 2. Start the dev database and Redis
|
||||
### 2. Start the dev database
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose.yml -f docker-compose.dev.yml up mariadb redis -d
|
||||
docker compose -f docker-compose.yml -f docker-compose.dev.yml up mariadb -d
|
||||
```
|
||||
|
||||
The dev override (`docker-compose.dev.yml`) exposes MariaDB on `localhost:3306` and Redis on `localhost:6379`.
|
||||
The dev override (`docker-compose.dev.yml`) exposes MariaDB on `localhost:3306`.
|
||||
|
||||
### 3. Configure environment variables
|
||||
|
||||
@@ -238,17 +238,16 @@ Migration files live in `apps/api/src/db/migrations/` and are committed to versi
|
||||
## Docker Compose Dev Stack
|
||||
|
||||
```bash
|
||||
# Bring up the full dev stack (API in Docker + MariaDB + Redis, with ports exposed)
|
||||
# Bring up the full dev stack (API in Docker + MariaDB, with ports exposed)
|
||||
docker compose -f docker-compose.yml -f docker-compose.dev.yml up
|
||||
|
||||
# Bring up only backing services (run API on host for faster iteration)
|
||||
docker compose -f docker-compose.yml -f docker-compose.dev.yml up mariadb redis -d
|
||||
docker compose -f docker-compose.yml -f docker-compose.dev.yml up mariadb -d
|
||||
```
|
||||
|
||||
The dev override:
|
||||
|
||||
- Exposes MariaDB on `localhost:3306`
|
||||
- Exposes Redis on `localhost:6379`
|
||||
- Mounts `apps/api/src` into the container for live source access
|
||||
- Sets `NODE_ENV=development`
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ This guide walks from a fresh clone to a running local development environment.
|
||||
| ----------------------- | ------------------ | ---------------------------------------------------------------------------------- |
|
||||
| Node.js | `22 LTS` | Matches the `node:22-alpine` base in `apps/api/Dockerfile` |
|
||||
| pnpm | `11.5.1` | Pinned in `package.json` `packageManager` field; enable via `corepack enable pnpm` |
|
||||
| Docker + Docker Compose | Any recent version | Used to run MariaDB and Redis locally |
|
||||
| Docker + Docker Compose | Any recent version | Used to run MariaDB locally |
|
||||
|
||||
**Node version management:** If you use nvm or fnm, install Node 22 LTS and set it as the default before continuing. There is no `.nvmrc` in the repo; the target version comes from the Dockerfile.
|
||||
|
||||
@@ -72,10 +72,10 @@ Open `.env` and fill in the required values. See [docs/CONFIGURATION.md](CONFIGU
|
||||
### 5. Start the database services
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d mariadb redis
|
||||
docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d mariadb
|
||||
```
|
||||
|
||||
This starts MariaDB (bound to `localhost:3306`) and Redis (`localhost:6379`) using the dev override. Wait for MariaDB to pass its health check before proceeding.
|
||||
This starts MariaDB (bound to `localhost:3306`) using the dev override. Wait for MariaDB to pass its health check before proceeding.
|
||||
|
||||
### 6. Run database migrations
|
||||
|
||||
|
||||
+1
-1
@@ -89,7 +89,7 @@ pnpm --filter @familysync/pwa test:e2e:ui
|
||||
pnpm --filter @familysync/pwa test:e2e:headed
|
||||
```
|
||||
|
||||
The `baseURL` is driven by `PLAYWRIGHT_BASE_URL` (default: `http://localhost:5173`). In local mode the config reuses a running Vite dev server; in CI it starts Vite itself. The API, MariaDB, and Redis must already be running via Docker Compose before launching e2e tests locally — see `docs/DEVELOPMENT.md`.
|
||||
The `baseURL` is driven by `PLAYWRIGHT_BASE_URL` (default: `http://localhost:5173`). In local mode the config reuses a running Vite dev server; in CI it starts Vite itself. The API and MariaDB must already be running via Docker Compose before launching e2e tests locally — see `docs/DEVELOPMENT.md`.
|
||||
|
||||
### Type checking (separate from tests — required)
|
||||
|
||||
|
||||
+4
-5
@@ -16,11 +16,10 @@ Self-hosted Docker deployment on Unraid behind Authelia OIDC and a Pangolin/Newt
|
||||
|
||||
The production compose file brings up three services:
|
||||
|
||||
| Service | Image | Purpose |
|
||||
| --------- | ---------------------------------------------------- | ---------------------------------------------------------- |
|
||||
| `api` | Built from `apps/api/Dockerfile` target `production` | Hono API + compiled React PWA, listens on port 3000 |
|
||||
| `mariadb` | `mariadb:11` | Persistent MariaDB database |
|
||||
| `redis` | `redis:7-alpine` | Present for live list sync (pub/sub); unused until Phase 4 |
|
||||
| Service | Image | Purpose |
|
||||
| --------- | ---------------------------------------------------- | --------------------------------------------------- |
|
||||
| `api` | Built from `apps/api/Dockerfile` target `production` | Hono API + compiled React PWA, listens on port 3000 |
|
||||
| `mariadb` | `mariadb:11` | Persistent MariaDB database |
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user