Desi-Clans/frontend/README.md
2026-10-08 02:52:58 +05:30

40 lines
1.1 KiB
Markdown

# Desi Clans — Frontend
React + Vite foundation for the public site and (later) admin UI.
## Stack
- React (JSX), Vite, Tailwind CSS v3, React Router, Axios, GSAP, Lucide React
## Setup
```bash
cd frontend
cp .env.example .env # optional; empty VITE_API_URL uses dev proxy
npm install
npm run dev
```
App: [http://localhost:5173](http://localhost:5173)
## Scripts
| Command | Description |
|---------|-------------|
| `npm run dev` | Development server with HMR |
| `npm run build` | Production build to `dist/` |
| `npm run preview` | Preview production build |
| `npm run lint` | Oxlint |
## Structure
See [../docs/ARCHITECTURE.md](../docs/ARCHITECTURE.md) for the target `src/` layout.
## Design system
Reusable primitives live in `src/components/` (barrel: `src/components/index.js`).
- Home (mock marketing): [http://localhost:5173/](http://localhost:5173/)
- Event detail (mock): [http://localhost:5173/events/rang-barse-palace-grounds-2026](http://localhost:5173/events/rang-barse-palace-grounds-2026)
- Design system catalog: [http://localhost:5173/system](http://localhost:5173/system)