Chore/add setup and contributing docs (#90)

* chore: add dev setup documentation

* Add agents.md files

* simplify contributing documentation
This commit is contained in:
Abhishek 2025-12-27 09:25:20 +05:30 committed by GitHub
parent e83f3a36d2
commit 59894d7dec
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
20 changed files with 510 additions and 329 deletions

6
ui/.env.example Normal file
View file

@ -0,0 +1,6 @@
NEXT_PUBLIC_BACKEND_URL=http://localhost:8000
BACKEND_URL=http://localhost:8000
NEXT_PUBLIC_NODE_ENV=development
NEXT_PUBLIC_DEPLOYMENT_MODE: "oss"
NEXT_PUBLIC_AUTH_PROVIDER="local"

56
ui/AGENTS.md Normal file
View file

@ -0,0 +1,56 @@
# UI - Frontend Application
Next.js 15 frontend for the Dograh voice AI platform.
## Project Structure
```
ui/
├── src/
│ ├── app/ # Next.js App Router pages
│ ├── components/ # React components
│ ├── lib/ # Utilities and configurations
│ ├── client/ # Auto-generated API client
│ ├── context/ # React context providers
│ ├── hooks/ # Custom React hooks
│ ├── constants/ # Application constants
│ └── types/ # TypeScript type definitions
├── public/ # Static assets
└── package.json
```
## Where to Find Things
| Looking for... | Go to... |
| ------------------- | ---------------------------------------------------- |
| Pages/routes | `src/app/` - Next.js App Router (file-based routing) |
| Reusable components | `src/components/` - organized by feature |
| Base UI primitives | `src/components/ui/` - shadcn/ui components |
| Workflow builder | `src/components/flow/` - React Flow based |
| API calls | `src/client/` - auto-generated from OpenAPI spec |
| Auth utilities | `src/lib/auth/` |
| Helper functions | `src/lib/utils.ts` |
| Global state | `src/context/` - React context providers |
## Tech Stack
- Next.js 15 with App Router, React 19, TypeScript
- Tailwind CSS with shadcn/ui components
- Zustand for state management
- @xyflow/react for workflow builder
- LiveKit for WebRTC voice
## API Client
The `src/client/` directory is auto-generated from the backend OpenAPI spec:
```bash
npm run generate-client
```
## Development
```bash
npm install
npm run dev # Runs on port 3000
```

1
ui/CLAUDE.md Normal file
View file

@ -0,0 +1 @@
@AGENTS.md