Skip to content

Commit c5c0cef

Browse files
committed
refactor: 💡 readme
1 parent 9d2992a commit c5c0cef

1 file changed

Lines changed: 86 additions & 131 deletions

File tree

README.md

Lines changed: 86 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,44 @@
44

55
</h1>
66

7-
<h3 align="center">Ship web + desktop apps from one codebase.<br/>Fully typed. AI-ready. Production-grade.</h3>
7+
<h3 align="center">The starting point for web + desktop apps.<br/>Fully typed. AI-ready. Production-grade architecture.</h3>
88

99
<p align="center">
10-
Stop wiring together auth, permissions, realtime, and deployment targets.<br/>
11-
Start building your product on day one.
10+
A clean, empty full-stack template.<br/>
11+
Add features as you need them — one command at a time.
1212
</p>
1313

14+
<h3 align="center">Get started:</h3>
15+
16+
```bash
17+
npx @hype-stack/cli create
18+
```
19+
20+
&nbsp;
21+
22+
## What Is Hype Stack?
23+
24+
Hype Stack is a **modern full-stack template** — not a boilerplate packed with someone else's opinions. You get a clean, empty project with rock-solid architecture and tooling already wired up. No demo features to rip out. No dead code to clean up.
25+
26+
Build whatever you want from day one.
27+
1428
&nbsp;
1529

16-
## TL;DR
30+
## How It Works
31+
32+
Hype Stack follows the same model as [shadcn/ui](https://ui.shadcn.com) — but for full-stack features.
33+
34+
1. **Scaffold** your project with the CLI
35+
2. **Add packs** when you need them — auth, orgs, realtime, storage, desktop, and more
36+
3. Each pack drops production-ready code **into your codebase** — you own it, you modify it
37+
38+
```bash
39+
npx @hype-stack/cli create # Create a new project
40+
npx @hype-stack/cli add auth # Add authentication pack
41+
npx @hype-stack/cli add orgs # Add organizations & RBAC pack
42+
```
1743

18-
- 🖥️ **One codebase** → Web, macOS, Windows, Linux apps
19-
- 🔒 **Auth, orgs, RBAC, invitations** — wired and working
20-
- 🔗 **True end-to-end types** — frontend imports backend contracts directly
21-
- 🤖 **Built for AI agents** — vertical structure, Cursor rules, instant feedback loops
22-
-**Rust-powered tooling** — sub-second lint, format, and HMR
44+
No lock-in. No runtime dependency. Just code in your repo.
2345

2446
&nbsp;
2547

@@ -48,52 +70,34 @@ Start building your product on day one.
4870
</a>
4971
</p>
5072

51-
## Quick Start
73+
## What You Get Out of the Box
5274

53-
```bash
54-
# Clone and install
55-
git clone https://github.com/BetterTyped/hype-stack.git
56-
cd hype-stack
57-
pnpm install
75+
The template ships with **zero features** and **everything you need to build them**:
5876

59-
# Start infrastructure
60-
cd apps/backend && docker compose up -d && cd ../..
61-
62-
# Run migrations
63-
pnpm --filter backend exec prisma migrate deploy
64-
pnpm --filter backend exec prisma generate
65-
66-
# Launch everything
67-
pnpm dev
68-
```
69-
70-
> Web app runs on Vite. Backend on Hono. Both hot-reload instantly.
77+
- **Monorepo** — frontend, backend, and shared packages in one repo
78+
- **End-to-end types** — frontend imports backend contracts directly, no codegen
79+
- **Rust-powered tooling** — OXC linting, formatting, Vite 8 HMR in milliseconds
80+
- **AI-native structure** — vertical architecture with Cursor rules and agent skills
81+
- **Desktop-ready** — Electron Forge pre-configured for macOS, Windows, and Linux
82+
- **Testing setup** — Vitest, React Testing Library, Playwright E2E ready to go
7183

7284
&nbsp;
7385

74-
## The Problem
86+
## Available Packs
7587

76-
Every new product starts the same way:
88+
Need features? Add them with a single command. Each pack installs production-grade, fully-typed code directly into your project.
7789

78-
- ❌ Weeks spent wiring auth, sessions, and org management
79-
- ❌ Separate repos for web and desktop — diverging logic, double maintenance
80-
- ❌ Types break silently between frontend and backend
81-
- ❌ AI tools struggle with scattered, deeply nested project structures
82-
- ❌ "Templates" that give you a login page and nothing else
90+
| Pack | What it adds |
91+
| ---- | ------------ |
92+
| **Auth** | Email/password, OAuth, email verification, password reset, sessions |
93+
| **Organizations** | Multi-org support, invitations, org switching |
94+
| **RBAC** | Role-based access control, permission gates on routes and UI |
95+
| **Realtime** | Typed WebSocket events, live notifications |
96+
| **Storage** | S3-compatible file uploads with validation |
97+
| **Desktop** | macOS signing, Windows installers, Linux packages, auto-update |
98+
| **Observability** | Sentry error tracking, PostHog analytics, structured logging |
8399

84-
&nbsp;
85-
86-
## The Solution
87-
88-
Hype Stack gives you a **production architecture**, not a starter kit:
89-
90-
- ✅ Auth, OAuth, email verification, password reset — done
91-
- ✅ Organizations, invitations, role-based access — done
92-
- ✅ Realtime notifications over typed WebSockets — done
93-
- ✅ File uploads with S3-compatible storage — done
94-
- ✅ Desktop builds with signing, auto-update, and native menus — done
95-
96-
You write features. Everything else is already handled.
100+
> Packs are purchased separately. Run `npx @hype-stack/cli packs` to browse what's available.
97101
98102
&nbsp;
99103

@@ -113,29 +117,23 @@ You write features. Everything else is already handled.
113117
</a>
114118
</p>
115119

116-
## Why This Isn't Just Another Template
117-
118-
Most templates solve **setup**. Hype Stack solves **architecture**.
120+
## Why Hype Stack?
119121

120-
### 🧠 AI-Native Structure
122+
### Clean Slate, Not a Gutting Job
121123

122-
The codebase follows a [vertical architecture](https://tkdodo.eu/blog/the-vertical-codebase) — each feature owns its routes, UI, data access, types, and tests. AI agents work in small, isolated areas instead of navigating tangled cross-cutting layers.
124+
Most templates give you a demo app and expect you to delete half of it. Hype Stack gives you an empty project with the hard parts already solved — monorepo wiring, type bridges, tooling, CI.
123125

124-
Bundled Cursor rules and agent skills teach LLMs exactly how to add features, handle errors, and follow conventions.
126+
### Built for AI Agents
125127

126-
### 🔗 Zero-Codegen Type Safety
128+
The codebase follows a [vertical architecture](https://tkdodo.eu/blog/the-vertical-codebase) — each feature owns its routes, UI, data access, types, and tests. Bundled Cursor rules and agent skills teach LLMs exactly how to add features and follow conventions. Fast tooling gives agents sub-second feedback loops.
127129

128-
No OpenAPI specs. No code generators. No stale types.
130+
### Zero-Codegen Type Safety
129131

130-
The frontend imports `@hype-stack/backend` as a workspace dependency. HTTP routes and WebSocket events flow through a typed bridge — change a backend response, and TypeScript catches every mismatched consumer instantly.
132+
No OpenAPI specs. No code generators. The frontend imports `@hype-stack/backend` as a workspace dependency. HTTP routes and WebSocket events flow through a typed bridge — change a backend response, and TypeScript catches every mismatched consumer instantly.
131133

132-
### 🖥️ One Product, Every Platform
134+
### One Codebase, Every Platform
133135

134-
Same React app runs as a web SPA and an Electron desktop app. One `VITE_APP_TYPE` flag controls the split. Electron Forge handles macOS signing, Windows installers, Linux packages, and GitHub release publishing.
135-
136-
### ⚡ Speed as a Feature
137-
138-
Vite 8, OXC linting, `oxfmt` formatting, Nx caching. The feedback loop is measured in milliseconds, not minutes — for you and for AI agents iterating on your code.
136+
Same React app runs as a web SPA and an Electron desktop app. One `VITE_APP_TYPE` flag controls the split. Desktop builds are ready when you are.
139137

140138
&nbsp;
141139

@@ -155,7 +153,7 @@ Vite 8, OXC linting, `oxfmt` formatting, Nx caching. The feedback loop is measur
155153
</a>
156154
</p>
157155

158-
## How It Works
156+
## Architecture
159157

160158
```
161159
┌─────────────────────────────────────────────────┐
@@ -165,73 +163,14 @@ Vite 8, OXC linting, `oxfmt` formatting, Nx caching. The feedback loop is measur
165163
│ ───────────── │ ──────────── │
166164
│ React 19 │ Hono │
167165
│ TanStack Router│ Prisma + Kysely │
168-
│ HyperFetch SDK │ WorkOS Auth
166+
│ HyperFetch SDK │ Zod validation
169167
│ Electron Forge │ Typed WebSockets │
170-
│ shadcn/ui │ S3 Storage
168+
│ shadcn/ui │
171169
├─────────────────┴───────────────────────────────┤
172170
│ packages/enums — shared permissions & config │
173171
└─────────────────────────────────────────────────┘
174172
```
175173

176-
**Frontend** calls the backend through a fully-typed SDK generated from Hono route definitions. WebSocket events use the same type bridge. Permissions resolve from WorkOS roles into CASL abilities — enforced on both server and client.
177-
178-
&nbsp;
179-
180-
## Features
181-
182-
### 🔐 Authentication & Identity
183-
184-
- Email/password, Google OAuth (via WorkOS)
185-
- Email verification, password reset flows
186-
- Sealed session cookies
187-
- Multi-organization support with org switching
188-
189-
### 👥 Organizations & Collaboration
190-
191-
- Create and manage organizations
192-
- Invite members via email with token-based accept flow
193-
- Role-based access control (Admin, Member — extensible)
194-
- Permission gates on routes and UI components
195-
196-
### 🔔 Realtime
197-
198-
- WebSocket infrastructure with typed events
199-
- Live notifications (push + mark-read)
200-
- Invitation events for instant collaboration UX
201-
202-
### 📁 Storage & Uploads
203-
204-
- S3-compatible object storage (RustFS in dev, any S3 in production)
205-
- Avatar uploads with size/type validation
206-
- Typed file middleware with memory and disk strategies
207-
208-
### 🖥️ Desktop App
209-
210-
- macOS (DMG + code signing + notarization)
211-
- Windows (Squirrel installer + auto-update)
212-
- Linux (deb + rpm)
213-
- Native window controls, menus, clipboard, persistent store
214-
215-
### 📊 Observability
216-
217-
- Sentry error tracking (web + Electron main/renderer)
218-
- PostHog product analytics
219-
- Structured logging on backend
220-
221-
### 🧪 Testing
222-
223-
- Vitest unit/integration tests for backend features
224-
- React Testing Library for frontend components
225-
- Playwright E2E with isolated test infrastructure
226-
- Dedicated Docker Compose for test databases
227-
228-
### 🤖 AI Development Experience
229-
230-
- 15+ Cursor rules defining conventions for every layer
231-
- Agent skills for brainstorming, Hono, Prisma, frontend design
232-
- Vertical structure minimizes blast radius per change
233-
- Fast tooling gives agents sub-second feedback
234-
235174
&nbsp;
236175

237176
## Tech Stack
@@ -240,14 +179,31 @@ Vite 8, OXC linting, `oxfmt` formatting, Nx caching. The feedback loop is measur
240179
| ---------- | --------------------------------------------------------- |
241180
| Frontend | React 19, TanStack Router, Tailwind v4, shadcn/ui, Motion |
242181
| Backend | Hono, Prisma, Kysely, Zod |
243-
| Auth | WorkOS (sessions, OAuth, orgs) |
244-
| Realtime | Hono WebSockets, HyperFetch Sockets |
245182
| Desktop | Electron Forge (macOS, Windows, Linux) |
246183
| Database | PostgreSQL 17 + pgvector |
247184
| Cache | Valkey (Redis-compatible) |
248-
| Storage | S3-compatible (RustFS / AWS / any provider) |
249185
| Tooling | Nx, Vite 8, OXC, pnpm, TypeScript 6 |
250-
| Monitoring | Sentry, PostHog |
186+
187+
&nbsp;
188+
189+
## Quick Start
190+
191+
```bash
192+
# Create a new project
193+
npx @hype-stack/cli create
194+
195+
# Start infrastructure
196+
cd apps/backend && docker compose up -d && cd ../..
197+
198+
# Run migrations
199+
pnpm --filter backend exec prisma migrate deploy
200+
pnpm --filter backend exec prisma generate
201+
202+
# Launch everything
203+
pnpm dev
204+
```
205+
206+
> Web app runs on Vite. Backend on Hono. Both hot-reload instantly.
251207
252208
&nbsp;
253209

@@ -302,9 +258,8 @@ pnpm test:clean # Tear down test infrastructure
302258
---
303259

304260
<p align="center">
305-
<strong>Stop assembling infrastructure. Start shipping product.</strong><br/><br/>
306-
Hype Stack gives you the architecture that takes teams months to build —<br/>
307-
typed, tested, and ready for AI-assisted development from commit one.
261+
<strong>Start empty. Add what you need. Ship fast.</strong><br/><br/>
262+
Hype Stack gives you the architecture — you choose the features.
308263
</p>
309264

310265
## License

0 commit comments

Comments
 (0)