How thu-maic/openmaic-project works
OpenMAIC-Project is an Electron desktop environment for project-based learning. A learner configures the local app, submits a project brief, reviews a generated plan, then works with role-based AI collaborators in a sandboxed workspace using chat, documents, files, code, terminal, and browser tools. The endpoint separates planner sessions from learning-phase sessions and exposes project design and workspace APIs. The README documents the lifecycle and major capabilities; source excerpts and the index establish selected runtime links, but do not expose all UI-to-API wiring.
Main entry points: project_planner/session.py Planner session · App.tsx App routing · collaborator/session.py Collaborator sessions · instructor/session.py Instructor session
Components 24
Desktop client
- Electron main
src/main/main.ts - Endpoint manager
src/main/endpoint-manager.ts - App routing
src/renderer/App.tsx - Setup wizard
src/renderer/pages/setup/steps/InfraStep.tsx - Planner UI
src/renderer/pages/project/StartPage.tsx - Plan review
src/renderer/pages/project/ReviewPage.tsx - Workspace shell
src/renderer/pages/workspace/WorkspaceShell.tsx - Workspace tools
src/renderer/pages/workspace/components/WorkArea.tsx
Local endpoint
- FastAPI routes
endpoint/main.py
Project planning
- Planner routes
endpoint/api/project_planner.py - Planner session
endpoint/service/project_planner/session.py - Planner agent
endpoint/service/project_planner/agent.py
Learning workspace
- Collaborator sessions
endpoint/service/workspace/collaborator/session.py - Instructor session
endpoint/service/workspace/instructor/session.py - Scene actor sessions
endpoint/service/workspace/simulator/session.py - Workspace container
endpoint/service/workspace/container.py - Shared documents
endpoint/api/integrations.py
Project design
- Project metadata
endpoint/api/project_design/project.py - Role definitions
endpoint/api/project_design/roles.py - Milestones and tasks
endpoint/api/project_design/issueboard.py - Agent authorization
endpoint/api/project_design/auth.py
Other components
- Learner
- LLM provider
- Docker sandbox
Connections 28
- Learner → App routing: uses
README.md - Electron main → Endpoint manager: starts endpoint
src/main/main.ts - Endpoint manager → FastAPI routes: launches
src/main/endpoint-manager.ts - App routing → Setup wizard: routes setup
src/renderer/App.tsx - App routing → Planner UI: routes brief
src/renderer/App.tsx - App routing → Plan review: routes review
src/renderer/App.tsx - App routing → Workspace shell: routes workspace
src/renderer/App.tsx - Workspace shell → Workspace tools: renders tools
- FastAPI routes → Planner routes: registers routes
endpoint/main.py - Planner routes → Planner session: delegates
endpoint/service/project_planner/session.py - Planner session → Planner agent: runs agent
endpoint/service/project_planner/session.py - Planner session → Project metadata: reads project
endpoint/service/project_planner/session.py - Planner session → Role definitions: uses role design
endpoint/service/project_planner/session.py - Planner session → Milestones and tasks: uses issueboard
endpoint/service/project_planner/session.py - Planner session → LLM provider: requests reasoning
- Planner session → Plan review: returns plan
- Collaborator sessions → Workspace container: starts container
endpoint/service/workspace/collaborator/session.py - Scene actor sessions → Workspace container: starts container
endpoint/service/workspace/simulator/session.py - Instructor session → Collaborator sessions: consults sessions
endpoint/service/workspace/instructor/session.py - Collaborator sessions → Shared documents: uses documents
endpoint/service/workspace/collaborator/session.py - Instructor session → Shared documents: uses documents
endpoint/service/workspace/instructor/session.py - Collaborator sessions → LLM provider: runs collaborator
- Instructor session → LLM provider: runs instructor
- Scene actor sessions → LLM provider: runs scene actor
- Workspace container → Docker sandbox: manages
README.md - Workspace shell → Collaborator sessions: uses sessions
- Planner UI → Planner routes: submits brief
- Plan review → Project metadata: reviews design