How andreasnicklaus/cheer-choreo-tool works
Choreo Planer is a web application for planning cheerleading and dance choreography. Coaches use the Vue interface to manage choreographies, counts, hits, lineups, and member positions, then export plans as PDFs or videos. The backend provides HTTP APIs, authentication and access sharing, domain services, persistence, and an MCP interface for programmatic choreo management. The README documents the product capabilities; sampled code confirms selected frontend routing and backend service/model relationships. Several domain routes and integrations are unsampled, so their links are shown as unverified where needed.
Main entry points: index.ts HTTP API server · ChoreoService.ts Choreo services · UserService.ts User services · unlocalized-routes.mjs Page routing
Components 23
Web application
- Vue application
app/src/App.vue - Page routing
app/src/router/unlocalized-routes.mjs - API request client
app/src/services/RequestService.ts
Planning and exports
- Choreo editor
app/src/views/EditView.vue - Teams and seasons
app/src/views/TeamView.vue - PDF and video
app/src/views/VideoView.vue
API and identity
- HTTP API server
server/src/index.ts - Authentication
server/src/services/AuthService.ts
Domain services
- Choreo services
server/src/services/ChoreoService.ts - Lineup services
server/src/services/LineupService.ts - Position services
server/src/services/PositionService.ts - User services
server/src/services/UserService.ts - Access control
server/src/utils/accessControl.ts - Planning records
server/src/db/models/choreo.ts - Lineup records
server/src/db/models/lineup.ts - Member records
server/src/db/models/member.ts - User records
server/src/db/models/user.ts
Integrations
- MCP tools
server/src/mcp/tools.ts - Email delivery
server/src/services/MailService.ts - Notifications
server/src/services/NotificationService.ts
Other components
- Coach
- Email service
- AI agent
Connections 28
- Coach → Vue application: uses
- Vue application → Page routing: renders routes
- Page routing → Choreo editor: routes to
app/src/router/unlocalized-routes.mjs - Page routing → Teams and seasons: routes to
app/src/router/unlocalized-routes.mjs - Page routing → PDF and video: routes to
app/src/router/unlocalized-routes.mjs - Choreo editor → API request client: requests data
- Teams and seasons → API request client: requests data
- PDF and video → API request client: requests data
- API request client → HTTP API server: sends API requests
- HTTP API server → Authentication: registers routes
- HTTP API server → Choreo services: dispatches requests
- HTTP API server → Lineup services: dispatches requests
- HTTP API server → Position services: dispatches requests
- HTTP API server → User services: dispatches requests
- Authentication → User services: uses
server/src/services/AuthService.ts - Choreo services → Access control: checks access
server/src/services/ChoreoService.ts - Choreo services → Planning records: queries and updates
server/src/services/ChoreoService.ts - Choreo services → Lineup services: uses
server/src/services/ChoreoService.ts - Lineup services → Lineup records: queries records
server/src/services/LineupService.ts - Position services → Lineup records: loads lineups
server/src/services/PositionService.ts - Position services → Member records: loads members
server/src/services/PositionService.ts - Position services → Access control: checks access
server/src/services/PositionService.ts - User services → User records: queries records
server/src/services/UserService.ts - User services → Email delivery: sends mail
server/src/services/UserService.ts - User services → Notifications: creates notifications
server/src/services/UserService.ts - Email delivery → Email service: delivers email
- AI agent → MCP tools: uses MCP
- MCP tools → Choreo services: manages choreos