5b37f88477
- Add inline comments to docker-compose.yml explaining the 5 key rules (expose vs ports, DB host, DB name persistence, no Traefik labels) - Add comments to Dockerfile explaining multi-stage build, layer caching, and why .dockerignore excludes client/dist - Add comments to .dockerignore explaining each exclusion - Fix dev script: use nodemon (auto-restart) instead of node for server.js - Add postinstall script to auto-install client deps (cd client && npm install) - Fix SPA fallback: bare return → next() to prevent hanging requests - Add root package-lock.json for deterministic server dependency installs - Remove committed tsconfig.tsbuildinfo build artifact, add *.tsbuildinfo to .gitignore - Update README: simpler install (npm install handles everything), reference SAAC_DEPLOYMENT.md, use npx instead of pnpm dlx for shadcn components
71 lines
2.2 KiB
Markdown
71 lines
2.2 KiB
Markdown
# Company Website Template
|
|
|
|
React + shadcn/ui + Express + PostgreSQL + Redis scaffold for SAAC deployment.
|
|
|
|
## Stack
|
|
|
|
- **Frontend**: React 19 + Vite + TypeScript + TailwindCSS v4 + shadcn/ui
|
|
- **Backend**: Express.js (Node 20)
|
|
- **Database**: PostgreSQL 16
|
|
- **Cache**: Redis 7
|
|
- **Deploy**: Docker Compose via `saac deploy`
|
|
|
|
## Structure
|
|
|
|
```
|
|
├── server.js # Express backend (API + serves React build)
|
|
├── client/ # React frontend (Vite + shadcn/ui)
|
|
│ ├── src/
|
|
│ │ ├── components/ui/ # shadcn/ui components (Button, Card, Input, etc.)
|
|
│ │ ├── lib/utils.ts # cn() utility for Tailwind class merging
|
|
│ │ ├── pages/ # Page components
|
|
│ │ ├── App.tsx # Router
|
|
│ │ └── main.tsx # Entry point
|
|
│ ├── components.json # shadcn/ui config
|
|
│ ├── vite.config.ts # Vite config with path aliases
|
|
│ └── package.json # Client dependencies
|
|
├── docker-compose.yml # PostgreSQL + Redis + App (see comments inside)
|
|
├── Dockerfile # Multi-stage: build React → serve with Express
|
|
├── SAAC_DEPLOYMENT.md # Deployment rules — READ THIS FIRST
|
|
└── package.json # Server dependencies
|
|
```
|
|
|
|
## Development
|
|
|
|
```bash
|
|
# Install all dependencies (postinstall auto-installs client deps)
|
|
npm install
|
|
|
|
# Run backend + frontend concurrently (nodemon + Vite HMR)
|
|
npm run dev
|
|
|
|
# Or run separately:
|
|
npm run dev:server # Express on :3000 (with nodemon auto-restart)
|
|
npm run dev:client # Vite on :5173 (proxies /api to :3000)
|
|
```
|
|
|
|
## Adding shadcn/ui Components
|
|
|
|
```bash
|
|
cd client
|
|
npx shadcn@latest add dialog # Add Dialog component
|
|
npx shadcn@latest add table # Add Table component
|
|
npx shadcn@latest add select # Add Select component
|
|
```
|
|
|
|
Import: `import { Button } from "@/components/ui/button"`
|
|
|
|
## Deploy
|
|
|
|
```bash
|
|
saac deploy
|
|
```
|
|
|
|
See `SAAC_DEPLOYMENT.md` for deployment rules, common mistakes, and debugging commands.
|
|
|
|
## API Routes
|
|
|
|
- `GET /health` — Health check (PostgreSQL + Redis)
|
|
- `GET /api/status` — Example API endpoint
|
|
- `GET /*` — React SPA (served from client/dist)
|