NexisChat Documentation
NexisChat Documentation
Section titled “NexisChat Documentation”Version: 1.0 Generated: 2026-01-04 Project Type: Brownfield Monorepo
Welcome
Section titled “Welcome”NexisChat is a multi-tenant WhatsApp management platform that enables users to manage multiple WhatsApp accounts, organize conversations, and automate workflows.
Quick Links
Section titled “Quick Links”| Document | Description |
|---|---|
| Development Guide | Setup, scripts, and development workflow |
| Architecture | System design and data flow |
| Technology Stack | Complete tech inventory |
| API Contracts - Server | tRPC API reference |
| API Contracts - WhatsApp | REST API reference |
| Database Schema | PostgreSQL tables and relationships |
| UI Component Library | Shared component catalog |
| Authentication | Auth flows and security |
| CI/CD Pipeline | GitHub Actions workflows |
Project Structure
Section titled “Project Structure”NexisChat/├── apps/│ ├── client/ # Main chat client (TanStack Start)│ ├── server/ # API server (Hono + tRPC)│ ├── whatsapp-web-server/ # WhatsApp integration (Elysia)│ ├── subscription/ # Subscription portal (Next.js)│ ├── landing/ # Marketing site (Astro)│ └── docs/ # Documentation (Fumadocs)│├── packages/│ ├── ui/ # Shared component library│ ├── i18n/ # Internationalization│ ├── eslint-config/ # Shared ESLint configs│ └── typescript-config/ # Shared TypeScript configs│└── docs/ # This documentationGetting Started
Section titled “Getting Started”Prerequisites
Section titled “Prerequisites”- Node.js ≥18
- pnpm 10.16.1+
- Bun 1.2+ (for whatsapp-web-server)
- Docker (for local PostgreSQL)
Quick Start
Section titled “Quick Start”# Clone and installgit clone https://github.com/your-org/NexisChat.gitcd NexisChatpnpm install
# Setup environmentcp apps/server/.env.example apps/server/.env# Edit .env with your credentials
# Start databasecd apps/server && docker compose -f development.docker-compose.yml up -dpnpm db:push
# Start all servicespnpm devDevelopment URLs
Section titled “Development URLs”| Service | URL | Port |
|---|---|---|
| Client | http://localhost:3000 | 3000 |
| Server | http://localhost:8787 | 8787 |
| WhatsApp Server | http://localhost:8788 | 8788 |
| Subscription | http://localhost:3001 | 3001 |
| Landing | http://localhost:4321 | 4321 |
| Docs | http://localhost:3002 | 3002 |
| Storybook | http://localhost:6006 | 6006 |
| Drizzle Studio | http://localhost:4983 | 4983 |
Key Technologies
Section titled “Key Technologies”| Category | Technology |
|---|---|
| Monorepo | pnpm workspaces + Turborepo |
| Frontend | TanStack Start, Next.js, Astro |
| Backend | Hono, Elysia, tRPC 11 |
| Database | PostgreSQL + Drizzle ORM |
| Auth | WorkOS AuthKit + Better Auth |
| UI | Radix UI + TailwindCSS 4 |
| Testing | Vitest + Storybook + Chromatic |
Documentation Map
Section titled “Documentation Map”For New Developers
Section titled “For New Developers”- Start with Development Guide
- Review Architecture
- Explore Technology Stack
For API Consumers
Section titled “For API Consumers”- API Contracts - Server for tRPC endpoints
- API Contracts - WhatsApp for REST endpoints
- Authentication for auth flows
For UI Development
Section titled “For UI Development”- UI Component Library for component catalog
- Run
pnpm --filter ui storybookfor interactive docs
For DevOps
Section titled “For DevOps”- CI/CD Pipeline for workflow details
- Development Guide for environment setup
Contributing
Section titled “Contributing”See Development Guide for:
- Branch naming conventions
- Commit message format
- PR process
- Code review guidelines
Support
Section titled “Support”- Issues: GitHub Issues
- Docs Site:
/docsroute orapps/docs - Storybook:
pnpm --filter ui storybook
This documentation was generated using the BMAD document-project workflow.