docs: refresh README to match current app + fix compose secrets#20
Merged
Conversation
The README had drifted ~128 commits behind reality. Corrects: - broken doc links (MISSION/TECH_STACK/ROADMAP now under product-knowledge/) - auth: JWT email/password + optional Google/Facebook OAuth (authlib), not Auth.js - project status: deployed app on Railway, not "MVP scaffolding" - env setup: real required vars; VoIP.ms creds are per-user/encrypted, not in .env - adds Deployment section + links DEPLOY.md - refreshed feature list (diagnostics, family sharing, schedules) and structure tree - reorders Getting Started to lead with Docker Compose (primary user path) Also wires env_file: .env into the backend compose service so the documented `docker compose up` path actually boots — previously the backend never received JWT_SECRET/SESSION_SECRET/ENCRYPTION_KEY and failed config validation on startup. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The root
README.mdhad drifted ~128 commits behind the codebase (last updated 2026-03-04). It described an early scaffold; the repo is now a deployed, multi-feature app. This corrects the inaccurate and misleading claims, and fixes a realdocker compose upblocker discovered along the way.README corrections
MISSION.md/TECH_STACK.md/ROADMAP.mdnow live underproduct-knowledge/; links were dead.DATABASE_URL,ENCRYPTION_KEY,JWT_SECRET,SESSION_SECRET); clarifies VoIP.ms credentials are per-user and encrypted, not in.env.DEPLOY.md.specs/,product-knowledge/, Dockerfiles,railway.toml).docker-compose fix
Added
env_file: .envto the backend service. Without it the now-primarydocker compose uppath crashes on startup: the backend never receivedJWT_SECRET/SESSION_SECRET/ENCRYPTION_KEYand failedconfig.pyvalidation. The explicitDATABASE_URLinenvironment:still takes precedence, so the backend stays pointed at the Compose-manageddb.Verification
Pre-commit ran the full suite: 654 backend + 250 frontend tests pass, typecheck clean. The
docker compose upboot path has not been executed end-to-end — reviewer may want to confirm.🤖 Generated with Claude Code