2:I[7012,["4765","static/chunks/4765-f5afdf8061f456f3.js","9856","static/chunks/9856-3b185291364d9bef.js","6687","static/chunks/app/docs/%5B...slug%5D/page-e07536548216bee4.js"],"MarkdownRenderer"] 4:I[9856,["4765","static/chunks/4765-f5afdf8061f456f3.js","9856","static/chunks/9856-3b185291364d9bef.js","6687","static/chunks/app/docs/%5B...slug%5D/page-e07536548216bee4.js"],""] 5:I[4126,[],""] 7:I[9630,[],""] 8:I[4278,["9856","static/chunks/9856-3b185291364d9bef.js","8172","static/chunks/8172-b3a2d6fe4ae10d40.js","3185","static/chunks/app/layout-2814fa5d15b84fe4.js"],"HeadingProvider"] 9:I[1476,["9856","static/chunks/9856-3b185291364d9bef.js","8172","static/chunks/8172-b3a2d6fe4ae10d40.js","3185","static/chunks/app/layout-2814fa5d15b84fe4.js"],"Header"] a:I[3167,["9856","static/chunks/9856-3b185291364d9bef.js","8172","static/chunks/8172-b3a2d6fe4ae10d40.js","3185","static/chunks/app/layout-2814fa5d15b84fe4.js"],"Sidebar"] b:I[7409,["9856","static/chunks/9856-3b185291364d9bef.js","8172","static/chunks/8172-b3a2d6fe4ae10d40.js","3185","static/chunks/app/layout-2814fa5d15b84fe4.js"],"PageFrame"] 3:T1120, # Developer Quick Start **Last Updated:** 2025-12-01 Welcome to VoiceAssist development! This guide will get you up and running quickly. --- ## Prerequisites - **Node.js** 20+ and **pnpm** 8+ - **Python** 3.11+ with pip - **Docker** and Docker Compose - **Git** for version control --- ## Quick Setup (5 minutes) ### 1. Clone and Install ```bash # Clone the repository git clone https://github.com/your-org/VoiceAssist.git cd VoiceAssist # Install all dependencies pnpm install # Copy environment template cp .env.example .env ``` ### 2. Start Development Services ```bash # Start backend services (API Gateway, databases) docker-compose up -d # Start frontend development server pnpm dev ``` ### 3. Verify Setup - **Frontend:** http://localhost:5173 - **API Gateway:** http://localhost:8000 - **API Docs:** http://localhost:8000/docs --- ## Project Structure ``` VoiceAssist/ ├── apps/ │ ├── web-app/ # React frontend (Vite + TypeScript) │ ├── admin-panel/ # Admin dashboard │ └── docs-site/ # Documentation (Next.js) ├── packages/ │ ├── api-client/ # Type-safe API client │ ├── config/ # Shared configuration │ ├── types/ # TypeScript types │ ├── ui/ # Shared UI components │ └── utils/ # Shared utilities ├── services/ │ └── api-gateway/ # FastAPI backend └── docs/ # Documentation source ``` --- ## Key Documentation ### Architecture - [Unified Architecture](../UNIFIED_ARCHITECTURE.md) - Complete system overview - [Backend Architecture](../BACKEND_ARCHITECTURE.md) - API Gateway design - [Frontend Architecture](../FRONTEND_ARCHITECTURE.md) - React app structure - [Realtime Architecture](../REALTIME_ARCHITECTURE.md) - WebSocket systems ### Voice Pipeline - [Thinker-Talker Pipeline](../THINKER_TALKER_PIPELINE.md) - Voice architecture (recommended) - [Voice Mode Pipeline](../VOICE_MODE_PIPELINE.md) - Voice mode overview - [Voice Pipeline WebSocket](../api-reference/voice-pipeline-ws.md) - WebSocket protocol ### API Reference - [REST API Reference](../api-reference/rest-api.md) - Complete endpoint docs - [WebSocket Protocol](../WEBSOCKET_PROTOCOL.md) - Real-time communication - [Data Model](../DATA_MODEL.md) - Database schema ### Development - [Development Setup](../DEVELOPMENT_SETUP.md) - Full setup guide - [Local Development](../LOCAL_DEVELOPMENT.md) - Local environment tips - [Testing Guide](../TESTING_GUIDE.md) - Testing strategies --- ## Common Development Tasks ### Running Tests ```bash # Frontend tests pnpm test # Backend tests cd services/api-gateway pytest tests/ -v # E2E tests pnpm test:e2e ``` ### Code Quality ```bash # Lint all packages pnpm lint # Type check pnpm typecheck # Format code pnpm format ``` ### Building for Production ```bash # Build all apps pnpm build # Build specific app pnpm --filter web-app build ``` --- ## Development Workflow ### Branch Naming - `feature/` - New features - `fix/` - Bug fixes - `docs/` - Documentation updates - `refactor/` - Code refactoring ### Commit Messages Follow conventional commits: ``` feat(voice): add speech interruption support fix(api): handle null conversation IDs docs(readme): update installation instructions ``` ### Pull Requests 1. Create feature branch from `main` 2. Make changes with tests 3. Run `pnpm lint && pnpm test` 4. Open PR with description 5. Address review feedback 6. Squash and merge --- ## Key Services | Service | Port | Description | | ----------- | ---- | ---------------- | | Web App | 5173 | React frontend | | API Gateway | 8000 | FastAPI backend | | PostgreSQL | 5432 | Main database | | Redis | 6379 | Cache & sessions | | MinIO | 9000 | Object storage | --- ## Getting Help - **Documentation:** [assistdocs.asimo.io](https://assistdocs.asimo.io) - **Architecture Questions:** See [UNIFIED_ARCHITECTURE.md](../UNIFIED_ARCHITECTURE.md) - **API Questions:** See [API_REFERENCE.md](../API_REFERENCE.md) --- ## Next Steps 1. Read the [Architecture Overview](../UNIFIED_ARCHITECTURE.md) 2. Explore the [Thinker-Talker Pipeline](../THINKER_TALKER_PIPELINE.md) 3. Review the [API Reference](../API_REFERENCE.md) 4. Check [Contributing Guide](../DEVELOPMENT_SETUP.md) 6:["slug","start/developers","c"] 0:["X7oMT3VrOffzp0qvbeOas",[[["",{"children":["docs",{"children":[["slug","start/developers","c"],{"children":["__PAGE__?{\"slug\":[\"start\",\"developers\"]}",{}]}]}]},"$undefined","$undefined",true],["",{"children":["docs",{"children":[["slug","start/developers","c"],{"children":["__PAGE__",{},[["$L1",["$","div",null,{"children":[["$","div",null,{"className":"mb-6 flex items-center justify-between gap-4","children":[["$","div",null,{"children":[["$","p",null,{"className":"text-sm text-gray-500 dark:text-gray-400","children":"Docs / Raw"}],["$","h1",null,{"className":"text-3xl font-bold text-gray-900 dark:text-white","children":"Developer Quick Start"}],["$","p",null,{"className":"text-sm text-gray-600 dark:text-gray-400","children":["Sourced from"," ",["$","code",null,{"className":"font-mono text-xs","children":["docs/","start/developers.md"]}]]}]]}],["$","a",null,{"href":"https://github.com/mohammednazmy/VoiceAssist/edit/main/docs/start/developers.md","target":"_blank","rel":"noreferrer","className":"inline-flex items-center gap-2 rounded-md border border-gray-200 dark:border-gray-700 px-3 py-1.5 text-sm text-gray-700 dark:text-gray-200 hover:border-primary-500 dark:hover:border-primary-400 hover:text-primary-700 dark:hover:text-primary-300","children":"Edit on GitHub"}]]}],["$","div",null,{"className":"rounded-lg border border-gray-200 dark:border-gray-800 bg-white dark:bg-gray-900 p-6","children":["$","$L2",null,{"content":"$3"}]}],["$","div",null,{"className":"mt-6 flex flex-wrap gap-2 text-sm","children":[["$","$L4",null,{"href":"/reference/all-docs","className":"inline-flex items-center gap-1 rounded-md bg-gray-100 px-3 py-1 text-gray-700 hover:bg-gray-200 dark:bg-gray-800 dark:text-gray-200 dark:hover:bg-gray-700","children":"← All documentation"}],["$","$L4",null,{"href":"/","className":"inline-flex items-center gap-1 rounded-md bg-gray-100 px-3 py-1 text-gray-700 hover:bg-gray-200 dark:bg-gray-800 dark:text-gray-200 dark:hover:bg-gray-700","children":"Home"}]]}]]}],null],null],null]},[null,["$","$L5",null,{"parallelRouterKey":"children","segmentPath":["children","docs","children","$6","children"],"error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L7",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":"$undefined","notFoundStyles":"$undefined"}]],null]},[null,["$","$L5",null,{"parallelRouterKey":"children","segmentPath":["children","docs","children"],"error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L7",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":"$undefined","notFoundStyles":"$undefined"}]],null]},[[[["$","link","0",{"rel":"stylesheet","href":"/_next/static/css/7f586cdbbaa33ff7.css","precedence":"next","crossOrigin":"$undefined"}]],["$","html",null,{"lang":"en","className":"h-full","children":["$","body",null,{"className":"__className_f367f3 h-full bg-white dark:bg-gray-900","children":[["$","a",null,{"href":"#main-content","className":"skip-to-content","children":"Skip to main content"}],["$","$L8",null,{"children":[["$","$L9",null,{}],["$","$La",null,{}],["$","main",null,{"id":"main-content","className":"lg:pl-64","role":"main","aria-label":"Documentation content","children":["$","$Lb",null,{"children":["$","$L5",null,{"parallelRouterKey":"children","segmentPath":["children"],"error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L7",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":[["$","title",null,{"children":"404: This page could not be found."}],["$","div",null,{"style":{"fontFamily":"system-ui,\"Segoe UI\",Roboto,Helvetica,Arial,sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\"","height":"100vh","textAlign":"center","display":"flex","flexDirection":"column","alignItems":"center","justifyContent":"center"},"children":["$","div",null,{"children":[["$","style",null,{"dangerouslySetInnerHTML":{"__html":"body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}"}}],["$","h1",null,{"className":"next-error-h1","style":{"display":"inline-block","margin":"0 20px 0 0","padding":"0 23px 0 0","fontSize":24,"fontWeight":500,"verticalAlign":"top","lineHeight":"49px"},"children":"404"}],["$","div",null,{"style":{"display":"inline-block"},"children":["$","h2",null,{"style":{"fontSize":14,"fontWeight":400,"lineHeight":"49px","margin":0},"children":"This page could not be found."}]}]]}]}]],"notFoundStyles":[]}]}]}]]}]]}]}]],null],null],["$Lc",null]]]] c:[["$","meta","0",{"name":"viewport","content":"width=device-width, initial-scale=1"}],["$","meta","1",{"charSet":"utf-8"}],["$","title","2",{"children":"Developer Quick Start | Docs | VoiceAssist Docs"}],["$","meta","3",{"name":"description","content":"Get started developing with VoiceAssist - setup, architecture, and contribution guide."}],["$","meta","4",{"name":"keywords","content":"VoiceAssist,documentation,medical AI,voice assistant,healthcare,HIPAA,API"}],["$","meta","5",{"name":"robots","content":"index, follow"}],["$","meta","6",{"name":"googlebot","content":"index, follow"}],["$","link","7",{"rel":"canonical","href":"https://assistdocs.asimo.io"}],["$","meta","8",{"property":"og:title","content":"VoiceAssist Documentation"}],["$","meta","9",{"property":"og:description","content":"Comprehensive documentation for VoiceAssist - Enterprise Medical AI Assistant"}],["$","meta","10",{"property":"og:url","content":"https://assistdocs.asimo.io"}],["$","meta","11",{"property":"og:site_name","content":"VoiceAssist Docs"}],["$","meta","12",{"property":"og:type","content":"website"}],["$","meta","13",{"name":"twitter:card","content":"summary"}],["$","meta","14",{"name":"twitter:title","content":"VoiceAssist Documentation"}],["$","meta","15",{"name":"twitter:description","content":"Comprehensive documentation for VoiceAssist - Enterprise Medical AI Assistant"}],["$","meta","16",{"name":"next-size-adjust"}]] 1:null