Private
Public Access
ksmithandClaude Sonnet 5
14dc340174
Renames the app's display name everywhere (page titles, PWA manifest, TopBar, email subject lines, HMAC signature header) and its internal technical slug from chatapp to ds-chat/ds_chat: the Python package name and console script, the systemd unit and its user/group/paths, the deploy scripts, the Docker container names, and the Postgres database name. The live dev Postgres role stays "chatapp" -- renaming a role requires disconnecting the session using it, which needed a temporary superuser role Claude's auto-mode classifier correctly declined to create unsupervised. Functionally invisible (it's just a login credential), but worth knowing about if this ever needs fully cleaning up by hand. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
56 lines
2.1 KiB
Markdown
56 lines
2.1 KiB
Markdown
# DS Chat
|
|
|
|
A web-based team chat service (Mattermost-style, no threaded conversations),
|
|
invite-only. See [ARCHITECTURE.md](ARCHITECTURE.md) for the full system design
|
|
and phased build plan.
|
|
|
|
**Phase 1**: auth, open-room CRUD, and single-instance WebSocket chat, backend
|
|
+ a minimal frontend. **Phase 2**: private rooms, room roles (owner/admin/
|
|
member), and room invites — backend only, see below. Later phases (push
|
|
notifications, Redis fan-out, the admin portal, the bot/extension system, and
|
|
production deployment) are tracked as issues in the repo's issue tracker,
|
|
prioritized.
|
|
|
|
## Structure
|
|
|
|
- [`backend/`](backend/) — FastAPI + SQLAlchemy 2.0 (async) + PostgreSQL. See
|
|
[`backend/README.md`](backend/README.md) for local setup, migrations, how to
|
|
create a user (site registration is invite-only — no public sign-up
|
|
endpoint), and the Phase 2 room-roles/invites API.
|
|
- [`frontend/`](frontend/) — React + Vite PWA (login, room list, chat view).
|
|
Still Phase-1-only: it doesn't yet call any of the Phase 2 endpoints. A UI
|
|
redesign is happening separately; frontend work resumes once that lands.
|
|
|
|
## Quickstart
|
|
|
|
```bash
|
|
# 1. Postgres (see backend/README.md for details)
|
|
docker run -d --name ds-chat-postgres \
|
|
-e POSTGRES_USER=ds_chat -e POSTGRES_PASSWORD=ds_chat -e POSTGRES_DB=ds_chat \
|
|
-p 5432:5432 postgres:16-alpine
|
|
|
|
# 2. Backend
|
|
cd backend
|
|
python3 -m venv .venv
|
|
.venv/bin/pip install -e ".[dev]"
|
|
cp .env.example .env # then set SESSION_SECRET
|
|
.venv/bin/alembic upgrade head
|
|
.venv/bin/python -m app.cli create-user alice alice@example.com "some-password"
|
|
.venv/bin/uvicorn app.main:app --reload &
|
|
|
|
# 3. Frontend (in another shell)
|
|
cd frontend
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
Then open http://localhost:5173 and log in with the account created above.
|
|
The Vite dev server proxies `/api` and `/ws` to the backend on `:8000`, so no
|
|
CORS configuration is needed in development.
|
|
|
|
## Deployment
|
|
|
|
See [DEPLOYMENT.md](DEPLOYMENT.md) for the full production runbook — two
|
|
Debian 13 servers, no containers, matching
|
|
[ARCHITECTURE.md §9](ARCHITECTURE.md#9-deployment-architecture--two-linux-servers-no-docker).
|