feat: initial CodeBoard monorepo scaffold
Turborepo monorepo with npm workspaces: - apps/web: Next.js 14 frontend with Tailwind v4, SSE progress, doc viewer - apps/worker: BullMQ job processor (clone → parse → LLM generate) - packages/shared: TypeScript types - packages/parser: Babel-based AST parser (JS/TS) + regex (Python) - packages/llm: OpenAI/Anthropic provider abstraction + prompt pipeline - packages/diagrams: Mermaid architecture & dependency graph generators - packages/database: Prisma schema (PostgreSQL) - Docker multi-stage build (web + worker targets) All packages compile successfully with tsc and next build.
This commit is contained in:
61
README.md
61
README.md
@@ -1,3 +1,60 @@
|
||||
# codeboard
|
||||
# CodeBoard
|
||||
|
||||
Codebase → Onboarding Docs Generator. Paste a GitHub repo URL, get interactive developer onboarding documentation in minutes.
|
||||
Codebase → Onboarding Docs Generator. Paste a GitHub repo URL, get interactive developer onboarding documentation in minutes.
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
codeboard/
|
||||
├── apps/
|
||||
│ ├── web/ # Next.js 14 frontend + API routes
|
||||
│ └── worker/ # BullMQ job processor
|
||||
├── packages/
|
||||
│ ├── shared/ # TypeScript types
|
||||
│ ├── parser/ # Babel-based AST parser (JS/TS) + regex (Python)
|
||||
│ ├── llm/ # OpenAI/Anthropic abstraction + prompt pipeline
|
||||
│ ├── diagrams/ # Mermaid diagram generators
|
||||
│ └── database/ # Prisma schema + client
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Build all packages
|
||||
npm run build
|
||||
|
||||
# Start with Docker
|
||||
docker compose up
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
# Run dev server (all workspaces)
|
||||
npm run dev
|
||||
|
||||
# Build
|
||||
npm run build
|
||||
```
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **Frontend**: Next.js 14, React 18, Tailwind CSS 4
|
||||
- **Backend**: BullMQ workers, Redis pub/sub for real-time progress
|
||||
- **Parser**: @babel/parser for JS/TS, regex-based for Python
|
||||
- **LLM**: Provider abstraction (OpenAI GPT-4o / Anthropic Claude)
|
||||
- **Diagrams**: Mermaid.js auto-generated architecture & dependency graphs
|
||||
- **Database**: PostgreSQL + Prisma
|
||||
- **Queue**: Redis + BullMQ
|
||||
- **Deployment**: Docker multi-stage builds
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
---
|
||||
|
||||
Built by [Vectry](https://company.repi.fun) — Engineering AI into your workflow.
|
||||
|
||||
Reference in New Issue
Block a user