Add README and technical docs

- README with quick start, package overview, links to docs
- docs/setup.md — prerequisites, env vars, installation, running, testing
- docs/architecture.md — monorepo structure, backend/frontend design
- docs/api.md — full endpoint reference with permissions
- docs/database.md — schema overview, migrations, multi-tenancy
- docs/testing.md — test runner, suites, writing tests
- Updated .env.example with all supported variables
This commit is contained in:
Ryan Moon
2026-03-29 08:31:20 -05:00
parent b9f78639e2
commit 1d48f0befa
7 changed files with 599 additions and 7 deletions

55
README.md Normal file
View File

@@ -0,0 +1,55 @@
# Forte
Music store management platform — POS, inventory, rentals, lessons, repairs, and accounting.
Built by [Lunarfront Tech LLC](https://lunarfront.com).
## Tech Stack
- **Runtime:** Bun
- **Language:** TypeScript (end-to-end)
- **API:** Fastify + Drizzle ORM + PostgreSQL 16
- **Frontend:** React + TanStack Router + TanStack Query
- **Validation:** Zod (shared schemas)
- **Queue/Cache:** BullMQ + Valkey 8
- **Monorepo:** Turborepo + Bun workspaces
## Quick Start
```bash
bun install
cp .env.example .env # configure DATABASE_URL, REDIS_URL, JWT_SECRET
cd packages/backend && bunx drizzle-kit migrate
bun run dev # starts backend (:8000) + admin UI (:5173)
```
## Packages
| Package | Description |
|---------|-------------|
| `packages/backend` | Fastify API server |
| `packages/admin` | Admin UI (React + Vite) |
| `packages/shared` | Zod schemas, types, shared utils |
## Documentation
| Doc | Description |
|-----|-------------|
| [Setup](docs/setup.md) | Prerequisites, environment, installation, running |
| [Architecture](docs/architecture.md) | Monorepo structure, backend/frontend design, state management |
| [API Reference](docs/api.md) | All endpoints, pagination, auth, permissions |
| [Database](docs/database.md) | Schema overview, migrations, multi-tenancy |
| [Testing](docs/testing.md) | Test runner, suites, writing tests, assertions |
## Commands
```bash
bun run dev # start all packages in dev mode
bun run test # run all tests
bun run lint # lint all packages
bun run format # format with Prettier
```
## License
Proprietary. All rights reserved.