76 lines
2.1 KiB
Markdown
76 lines
2.1 KiB
Markdown
# Luxe — Premium Companion Directory Platform
|
|
|
|
Enterprise-grade React frontend built for scale, performance, and premium UX.
|
|
|
|
## Tech Stack
|
|
|
|
- React 19 + TypeScript + Vite
|
|
- Material UI v7 (custom luxury theme)
|
|
- TanStack Query · Zustand · React Hook Form · Zod
|
|
- Framer Motion · i18next · React Helmet Async
|
|
- PWA-ready with service worker
|
|
|
|
## Getting Started
|
|
|
|
```bash
|
|
npm install
|
|
cp .env.example .env
|
|
npm run dev
|
|
```
|
|
|
|
Open [http://localhost:5173](http://localhost:5173).
|
|
|
|
## Scripts
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `npm run dev` | Start development server |
|
|
| `npm run build` | Production build |
|
|
| `npm run preview` | Preview production build |
|
|
| `npm run lint` | Run ESLint |
|
|
|
|
## Architecture
|
|
|
|
```
|
|
src/
|
|
├── app/ # App shell, providers, router
|
|
├── components/ # Shared UI (design system, layouts, search)
|
|
├── features/ # Feature modules (home sections, etc.)
|
|
├── pages/ # Route-level page components
|
|
├── layouts/ # Main, Auth, Dashboard layouts
|
|
├── theme/ # MUI theme, design tokens
|
|
├── store/ # Zustand stores
|
|
├── hooks/ # Custom React hooks
|
|
├── api/ # Axios client & interceptors
|
|
├── services/ # API service layer
|
|
├── validators/ # Zod schemas
|
|
├── types/ # TypeScript definitions
|
|
├── constants/ # App constants & mock data
|
|
├── config/ # i18n, env config
|
|
├── utils/ # Utility functions
|
|
└── styles/ # Global CSS
|
|
```
|
|
|
|
## Phase 1 (Complete)
|
|
|
|
- Enterprise folder structure
|
|
- Luxury design system (dark/light/auto themes)
|
|
- Responsive header with mobile drawer
|
|
- Global search with recent queries
|
|
- Premium landing page (all sections)
|
|
- Auth layout (login, register, forgot password)
|
|
- SEO metadata & structured data
|
|
- PWA manifest
|
|
|
|
## Phases Roadmap
|
|
|
|
- **Phase 2** — User-facing pages (profiles, cities, categories, blog)
|
|
- **Phase 3** — Advertiser dashboard
|
|
- **Phase 4** — Admin dashboard
|
|
- **Phase 5** — Blog & forum
|
|
- **Phase 6** — Wallet, ads, notifications, verification, analytics
|
|
|
|
## License
|
|
|
|
Private — All rights reserved.
|