28 lines
1.2 KiB
Markdown
28 lines
1.2 KiB
Markdown
# How to use this package with Codex
|
|
|
|
This package contains a Codex-ready build brief for a browser-first group coordination platform.
|
|
|
|
Recommended use:
|
|
|
|
1. Create an empty Git repository.
|
|
2. Copy `AGENTS.md`, `CODEX_TASK.md`, `PRODUCT_SPEC.md`, `ARCHITECTURE_CONTRACTS.md`, and `ACCEPTANCE_TESTS.md` into the repository root.
|
|
3. Open the repo in Codex.
|
|
4. Ask Codex:
|
|
|
|
```text
|
|
Read AGENTS.md and CODEX_TASK.md. Implement the full product described in PRODUCT_SPEC.md, ARCHITECTURE_CONTRACTS.md, and ACCEPTANCE_TESTS.md. Build a runnable monorepo. Do not stop at a prototype shell; deliver working vertical slices first, then deepen features until the acceptance tests pass.
|
|
```
|
|
|
|
Alternative: paste the contents of `CODEX_TASK.md` directly into Codex after adding the other files to the repo.
|
|
|
|
The intended result is a monorepo with:
|
|
|
|
```text
|
|
backend/ FastAPI app, DB models, API routes, seed data, tests
|
|
frontend/ React/Vite app, mobile-first UI, client API layer, tests
|
|
docker-compose.yml
|
|
README.md
|
|
```
|
|
|
|
The project deliberately excludes full federation, native apps, unofficial WhatsApp bridges, and production-grade end-to-end encryption. It includes local/self-hosted servers, a home-server model, and cross-server aggregation through scoped server connections.
|