Documentation

Complete guide to integrating and using Schoolama AI LMS. From quick setup to advanced features.

🚀

Getting Started

Welcome to Schoolama AI LMS! This guide will help you set up and start using our platform in just a few minutes.

For Administrators

Set up your school's digital infrastructure

  • ✓ School configuration
  • ✓ User management
  • ✓ Role assignments

For Teachers

Create engaging learning experiences

  • ✓ Course creation
  • ✓ Student tracking
  • ✓ Assessment tools
⚙️

Installation

Choose your preferred installation method:

Option 1: Cloud Hosted (Recommended)

Get started instantly with our managed cloud solution.

# No installation required!
Visit: https://schoolama-ai.vercel.app
Sign up and start your free trial

Option 2: Self-Hosted

Deploy on your own infrastructure for maximum control.

# Clone the repository
git clone https://github.com/schoolama/ai-lms.git
# Install dependencies
npm install
# Start development server
npm run dev
🔧

Configuration

Configure your Schoolama AI LMS instance to match your institution's needs.

Basic Settings

config/school.js
export const schoolConfig = {
name: "Your School Name",
timezone: "America/New_York",
academic_year: "2024-2025",
currency: "USD"
}

AI Settings

config/ai.js
export const aiConfig = {
analytics: true,
recommendations: true,
auto_grading: true,
language: "en"
}
👥

User Management

Manage users with role-based access control and automated workflows.

👨‍🎓

Students

Access courses, assignments, and grades

👨‍🏫

Teachers

Create content, grade, and track progress

👨‍💼

Admins

Full system access and management

# Create a new user
POST /api/users
{
"name": "John Doe",
"email": "john@school.edu",
"role": "student",
"class": "10A"
}
📊

Analytics & Insights

Harness the power of AI-driven analytics to improve educational outcomes.

Performance Tracking

  • 📈 Real-time grade analytics
  • 🎯 Learning outcome predictions
  • ⚡ Engagement metrics
  • 🔍 Risk identification

Reporting

  • 📋 Custom report builder
  • 📅 Scheduled reports
  • 📊 Interactive dashboards
  • 📤 Export capabilities
📚

API Reference

Integrate Schoolama AI LMS with your existing systems using our REST API.

Authentication

# Get API token
curl -X POST https://api.schoolama.ai/auth/token \
-H "Content-Type: application/json" \
-d '{"email":"admin@school.edu","password":"***"}'

Common Endpoints

GET /api/studentsList all students
POST /api/coursesCreate new course
PUT /api/grades/:idUpdate grade
DELETE /api/users/:idRemove user
🔗

Integrations

Connect with popular educational tools and services.

🎓Google Classroom
Active
💼Microsoft Teams
Active
📹Zoom
Active
🎨Canvas LMS
Beta
⚫Blackboard
Coming Soon
📚Moodle
Active
🔍

Troubleshooting

Encountered an issue? Here are some common problems and how to solve them.

  • Problem: Cannot login

    Ensure your credentials are correct and the server is reachable.

  • Problem: API requests failing

    Check your API token and endpoint URL. Refer to the API Reference section above.

  • Problem: Dashboard not loading

    Try clearing browser cache or switching to incognito mode.

  • Problem: AI recommendations not showing

    Ensure AI features are enabled in your configuration and you have enough usage data.

Still stuck? Contact support