How beacon-campus/beacon works
Beacon is a role-based campus collaboration platform for students, teachers, and administrators. Users sign in and complete onboarding, then enter role-specific home or community experiences to communicate, manage coursework, and access campus services; teachers publish and assess assignments, while admins manage users, classrooms, announcements, and operations. The React client calls an Express API, with MongoDB-backed domain data and Firebase identity. Chat and notifications also use Socket.IO, while uploads and AI assistance rely on external services. The graph follows README-described capabilities; unsampled module internals are represented by their existing directories.
Main entry points: controllers Domain controllers · App.jsx Role routing · models MongoDB domain data · AuthContext.jsx Sign-in onboarding
Components 24
Client experience
- Role routing
client/src/App.jsx - Sign-in onboarding
client/src/context/AuthContext.jsx - Home data
client/src/context/HomeDataContext.jsx - API client
client/src/services/apiClient.js - Admin operations
client/src/layouts/adminlayout/AdminLayout.jsx - Realtime client
client/src/components/SocketManager.jsx
Learning collaboration
- Chat experience
client/src/components/chat_comps - Classroom community
client/src/components/community_comps - Assignments quizzes
client/src/pages/teacher/teacher_community/TeacherPublishAssigment.jsx - Notes tasks sketch
client/src/pages/student/student_home - Study assistant
client/src/pages/student/student_home/StudentStudyBot.jsx
API and domain
- HTTP API
server/index.js - Token verification
server/middleware/auth.js - Domain controllers
server/controllers - Chat service
server/services/chat.service.js - Assignment workflows
server/services/assignment.service.js - Socket service
server/services/socket.service.js - Admin metrics logs
server/services/metrics.service.js
Persistence and identity
- MongoDB domain data
server/models
External services
- Firebase identity
- Cloudinary uploads
- Gemini AI
- Socket.IO transport
Other components
- Campus users
Connections 27
- Campus users → Sign-in onboarding: sign in
- Sign-in onboarding → Firebase identity: authenticates with
- Sign-in onboarding → API client: loads profile through
client/src/context/AuthContext.jsx - Campus users → Role routing: uses
client/src/App.jsx - Role routing → Chat experience: routes to
- Role routing → Classroom community: routes to
client/src/App.jsx - Role routing → Assignments quizzes: routes to
client/src/App.jsx - Campus users → Home data: views home data
- Home data → API client: fetches through
client/src/context/HomeDataContext.jsx - Campus users → Notes tasks sketch: manages
- Campus users → Study assistant: asks questions
- Campus users → Admin operations: administers platform
- API client → HTTP API: sends API requests
- HTTP API → Token verification: verifies protected requests
server/middleware/auth.js - HTTP API → Domain controllers: dispatches routes
server/index.js - Domain controllers → Chat service: delegates chat
server/controllers/chat.controller.js - Domain controllers → Assignment workflows: delegates assignments
server/controllers/assignment.controller.js - Chat service → MongoDB domain data: reads and writes
server/services/chat.service.js - Assignment workflows → MongoDB domain data: stores coursework
server/controllers/assignment.controller.js - Domain controllers → MongoDB domain data: accesses domain records
server/controllers/assignment.controller.js - Domain controllers → Cloudinary uploads: stores uploaded files
- Domain controllers → Gemini AI: requests AI responses
- Realtime client → Socket.IO transport: exchanges events
client/src/components/SocketManager.jsx - Socket service → Socket.IO transport: dispatches live events
- Realtime client → Socket service: receives updates from
- Admin operations → Admin metrics logs: views operational metrics
- Admin metrics logs → MongoDB domain data: samples domain counts
server/services/metrics.service.js