Files
guilan-ace-frontend/README.md

50 lines
1.9 KiB
Markdown

# Frontend
## Stack
- Next.js App Router with React 18 and TypeScript.
- `@tanstack/react-query` for client-side authenticated flows.
- Tailwind CSS and shadcn/ui components.
- `next-themes`, Sonner, and toast helpers for RTL UI and notifications.
## Environment
Copy `.env.sample` to `.env`.
Required variables:
- `NEXT_PUBLIC_API_BASE_URL`
- `NEXT_PUBLIC_SITE_URL`
## Development
```bash
npm install
npm run dev
```
The local dev server runs on `http://localhost:8080`.
## Production build
```bash
npm run build
npm run start
```
The production runtime serves on port `3000` inside Docker. Dockerfiles live only in `guilan-ace-deployment`.
## Routes
- Public SEO pages: `/`, `/about`, `/blog`, `/blog/[slug]`, `/events`, `/events/[slug]`
- Client-heavy flows: `/auth`, `/profile`, `/logout`, `/payments/result`, `/reset-password/*`, `/verify-email/*`
- Admin: `/admin/*`
## Validation
```bash
npm run lint
npm run build
```
## Project-local design skills
Clone this repository to get the frontend skills in `.agents/skills/`. The set includes `design-taste-frontend`, `vercel-react-best-practices`, `web-design-guidelines`, `ui-ux-pro-max`, `emil-design-eng`, `animate`, `entrance-motion`, `review-animations`, `playwright`, and `impeccable`. Keep each skill's complete directory, including its references and scripts.
Shared team guidance is also vendored in `.agents/skills/`: `grill-me`, `grilling`, `planning-and-task-breakdown`, `documentation-and-adrs`, and `git-workflow-and-versioning`.
Impeccable also installs a GitHub Copilot copy in `.github/skills/impeccable` and design hook manifests in `.codex/hooks.json` and `.github/hooks/impeccable.json`. Its portable launcher downloads a verified platform binary on first use; downloaded binaries are ignored by Git. In Codex, approve the project hook through `/hooks` after cloning. The shared hook setting is in `.impeccable/config.json`.