Compare commits
2 Commits
a826381981
...
6fe029f531
| Author | SHA1 | Date | |
|---|---|---|---|
| 6fe029f531 | |||
| 725901623b |
@@ -9,7 +9,8 @@ GearBox is a single-user web app for managing gear collections (bikepacking, sim
|
|||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Development (run both in separate terminals)
|
# Development
|
||||||
|
bun run dev # Starts both Vite client (:5173) and Hono server (:3000) concurrently
|
||||||
bun run dev:client # Vite dev server on :5173 (proxies /api to :3000)
|
bun run dev:client # Vite dev server on :5173 (proxies /api to :3000)
|
||||||
bun run dev:server # Hono server on :3000 with hot reload
|
bun run dev:server # Hono server on :3000 with hot reload
|
||||||
|
|
||||||
|
|||||||
41
README.md
41
README.md
@@ -10,7 +10,7 @@ A single-user web app for managing gear collections (bikepacking, sim racing, et
|
|||||||
- Research threads for comparing candidates before buying
|
- Research threads for comparing candidates before buying
|
||||||
- Image uploads for items and candidates
|
- Image uploads for items and candidates
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start (Docker)
|
||||||
|
|
||||||
### Docker Compose (recommended)
|
### Docker Compose (recommended)
|
||||||
|
|
||||||
@@ -81,3 +81,42 @@ docker compose up -d
|
|||||||
```
|
```
|
||||||
|
|
||||||
Database migrations run automatically on startup.
|
Database migrations run automatically on startup.
|
||||||
|
|
||||||
|
## Tech Stack
|
||||||
|
|
||||||
|
- **Runtime & Package Manager:** [Bun](https://bun.sh)
|
||||||
|
- **Frontend:** React 19, Vite, TanStack Router, TanStack Query, Tailwind CSS v4, Zustand
|
||||||
|
- **Backend:** Hono, Drizzle ORM, SQLite (`bun:sqlite`)
|
||||||
|
|
||||||
|
## Local Development Setup
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
You must have [Bun](https://bun.sh/) installed on your machine. Docker is not required for local development.
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
1. Install all dependencies:
|
||||||
|
```bash
|
||||||
|
bun install
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Initialize the local SQLite database (`gearbox.db`):
|
||||||
|
```bash
|
||||||
|
bun run db:push
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Start the development servers:
|
||||||
|
```bash
|
||||||
|
bun run dev
|
||||||
|
```
|
||||||
|
This single command will start both the Vite frontend server (port `5173`) and the Hono backend server (port `3000`) concurrently.
|
||||||
|
|
||||||
|
Open [http://localhost:5173](http://localhost:5173) in your browser to view the app.
|
||||||
|
|
||||||
|
## Additional Commands
|
||||||
|
|
||||||
|
- `bun run build` — Build the production assets into `dist/client/`
|
||||||
|
- `bun test` — Run the test suite
|
||||||
|
- `bun run lint` — Check formatting and lint rules using Biome
|
||||||
|
- `bun run db:generate` — Generate Drizzle migrations after making schema changes
|
||||||
94
package.json
94
package.json
@@ -1,48 +1,50 @@
|
|||||||
{
|
{
|
||||||
"name": "gearbox",
|
"name": "gearbox",
|
||||||
"module": "index.ts",
|
"module": "index.ts",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"dev:client": "vite",
|
"dev": "concurrently -k -c \"blue,green\" -n \"server,client\" \"bun run dev:server\" \"bun run dev:client\"",
|
||||||
"dev:server": "bun --hot src/server/index.ts",
|
"dev:client": "vite",
|
||||||
"build": "vite build",
|
"dev:server": "bun --hot src/server/index.ts",
|
||||||
"db:generate": "bunx drizzle-kit generate",
|
"build": "vite build",
|
||||||
"db:push": "bunx drizzle-kit push",
|
"db:generate": "bunx drizzle-kit generate",
|
||||||
"test": "bun test",
|
"db:push": "bunx drizzle-kit push",
|
||||||
"lint": "bunx @biomejs/biome check ."
|
"test": "bun test",
|
||||||
},
|
"lint": "bunx @biomejs/biome check ."
|
||||||
"devDependencies": {
|
},
|
||||||
"@biomejs/biome": "^2.4.7",
|
"devDependencies": {
|
||||||
"@tanstack/react-query-devtools": "^5.91.3",
|
"@biomejs/biome": "^2.4.7",
|
||||||
"@tanstack/react-router-devtools": "^1.166.7",
|
"@tanstack/react-query-devtools": "^5.91.3",
|
||||||
"@tanstack/router-plugin": "^1.166.9",
|
"@tanstack/react-router-devtools": "^1.166.7",
|
||||||
"@types/better-sqlite3": "^7.6.13",
|
"@tanstack/router-plugin": "^1.166.9",
|
||||||
"@types/bun": "latest",
|
"@types/better-sqlite3": "^7.6.13",
|
||||||
"@types/react": "^19.2.14",
|
"@types/bun": "latest",
|
||||||
"@types/react-dom": "^19.2.3",
|
"@types/react": "^19.2.14",
|
||||||
"@vitejs/plugin-react": "^6.0.1",
|
"@types/react-dom": "^19.2.3",
|
||||||
"better-sqlite3": "^12.8.0",
|
"@vitejs/plugin-react": "^6.0.1",
|
||||||
"drizzle-kit": "^0.31.9",
|
"better-sqlite3": "^12.8.0",
|
||||||
"vite": "^8.0.0"
|
"concurrently": "^9.1.2",
|
||||||
},
|
"drizzle-kit": "^0.31.9",
|
||||||
"peerDependencies": {
|
"vite": "^8.0.0"
|
||||||
"typescript": "^5.9.3"
|
},
|
||||||
},
|
"peerDependencies": {
|
||||||
"dependencies": {
|
"typescript": "^5.9.3"
|
||||||
"@hono/zod-validator": "^0.7.6",
|
},
|
||||||
"@tailwindcss/vite": "^4.2.1",
|
"dependencies": {
|
||||||
"@tanstack/react-query": "^5.90.21",
|
"@hono/zod-validator": "^0.7.6",
|
||||||
"@tanstack/react-router": "^1.167.0",
|
"@tailwindcss/vite": "^4.2.1",
|
||||||
"clsx": "^2.1.1",
|
"@tanstack/react-query": "^5.90.21",
|
||||||
"drizzle-orm": "^0.45.1",
|
"@tanstack/react-router": "^1.167.0",
|
||||||
"hono": "^4.12.8",
|
"clsx": "^2.1.1",
|
||||||
"lucide-react": "^0.577.0",
|
"drizzle-orm": "^0.45.1",
|
||||||
"react": "^19.2.4",
|
"hono": "^4.12.8",
|
||||||
"react-dom": "^19.2.4",
|
"lucide-react": "^0.577.0",
|
||||||
"recharts": "^3.8.0",
|
"react": "^19.2.4",
|
||||||
"tailwindcss": "^4.2.1",
|
"react-dom": "^19.2.4",
|
||||||
"zod": "^4.3.6",
|
"recharts": "^3.8.0",
|
||||||
"zustand": "^5.0.11"
|
"tailwindcss": "^4.2.1",
|
||||||
}
|
"zod": "^4.3.6",
|
||||||
|
"zustand": "^5.0.11"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user