Welcome to AiluroCamp Documentation¶
AiluroCamp is a comprehensive Learning Management System (LMS) designed to facilitate online education through a role-based platform.
About AiluroCamp¶
AiluroCamp LMS supports three user roles:
- Students: Can enroll in courses, complete assignments, track progress, and earn certificates
- Instructors: Can create and manage courses, assignments, and track student performance
- Administrators: Have full system access to manage users, courses, and platform settings
The application features a responsive UI built with Tailwind CSS and follows modern web development best practices.
Documentation Overview¶
This documentation is organized into the following sections:
Setup Guide¶
Detailed instructions for setting up the AiluroCamp Learning Management System for development and deployment.
- Development environment setup
- Installation steps
- Configuration options
- Deployment instructions
User Guide¶
Comprehensive instructions for using the AiluroCamp LMS for all user roles.
- Student features
- Instructor features
- Administrator features
- Common functionality
API Documentation¶
Details about the API endpoints available in the AiluroCamp Learning Management System.
- Authentication endpoints
- User management endpoints
- Course management endpoints
- Assignment management endpoints
Architecture¶
Technical overview of the AiluroCamp Learning Management System architecture.
- System design
- Core components
- Data flow
- Security considerations
TypeScript Type System¶
Explanation of the type system used in AiluroCamp and how we leverage TypeScript for type safety.
- Types folder structure
- Key type definitions
- Type safety best practices
- MongoDB and Mongoose types
Tech Stack¶
AiluroCamp is built with modern web technologies:
- Frontend: Next.js 14 with App Router, React, TypeScript
- Styling: Tailwind CSS
- Authentication: NextAuth.js with JWT
- Database: MongoDB with Mongoose ODM
- Deployment: GitHub Pages (static export) with separate API deployment
Getting Started¶
To get started with AiluroCamp, head over to the Setup Guide for installation instructions.