chore: Updated readme
4d37effe
1 file(s) · +7 −9
| 2 | 2 | ||
| 3 | 3 |  |
|
| 4 | 4 | ||
| 5 | - | A full-stack TypeScript monorepo starter with shared types, using Bun, Hono, Vite, React, and Turbo |
|
| 5 | + | A full-stack TypeScript monorepo starter with shared types, using Bun, Hono, Vite, and React. |
|
| 6 | 6 | ||
| 7 | 7 | ## Why bhvr? |
|
| 8 | 8 | ||
| 14 | 14 | - **Shared Types**: Common type definitions shared between client and server |
|
| 15 | 15 | - **Monorepo Structure**: Organized as a workspaces-based monorepo with Turbo for build orchestration |
|
| 16 | 16 | - **Modern Stack**: |
|
| 17 | - | - [Bun](https://bun.sh) as the JavaScript runtime |
|
| 17 | + | - [Bun](https://bun.sh) as the JavaScript runtime and package manager |
|
| 18 | 18 | - [Hono](https://hono.dev) as the backend framework |
|
| 19 | 19 | - [Vite](https://vitejs.dev) for frontend bundling |
|
| 20 | 20 | - [React](https://react.dev) for the frontend UI |
|
| 29 | 29 | ├── shared/ # Shared TypeScript definitions |
|
| 30 | 30 | │ └── src/types/ # Type definitions used by both client and server |
|
| 31 | 31 | ├── package.json # Root package.json with workspaces |
|
| 32 | - | └── turbo.json # Turbo configuration for build orchestration |
|
| 32 | + | └── turbo.json # Turbo configuration for build orchestration |
|
| 33 | 33 | ``` |
|
| 34 | 34 | ||
| 35 | 35 | ### Server |
|
| 203 | 203 | bun run dev |
|
| 204 | 204 | ||
| 205 | 205 | # Or run individual workspaces directly |
|
| 206 | - | cd client && bun run dev # Run the Vite dev server for React |
|
| 207 | - | cd server && bun run dev # Run the Hono backend |
|
| 208 | - | cd shared && bun run dev # Watch and compile shared types |
|
| 206 | + | bun run dev:client # Run the Vite dev server for React |
|
| 207 | + | bun run dev:server # Run the Hono backend |
|
| 209 | 208 | ``` |
|
| 210 | 209 | ||
| 211 | 210 | ### Building |
|
| 215 | 214 | bun run build |
|
| 216 | 215 | ||
| 217 | 216 | # Or build individual workspaces directly |
|
| 218 | - | cd shared && bun run build # Build the shared types package |
|
| 219 | - | cd server && bun run build # Build the Hono backend |
|
| 220 | - | cd client && bun run build # Build the React frontend |
|
| 217 | + | bun run build:client # Build the React frontend |
|
| 218 | + | bun run build:server # Build the Hono backend |
|
| 221 | 219 | ``` |
|
| 222 | 220 | ||
| 223 | 221 | ### Additional Commands |
|