Skip to main content

Introduction

Welcome to Smart Academic Hub documentation! This platform is a comprehensive multi-tenant SaaS solution designed for education businesses including tuition centres, coaching centres, swimming academies, karate schools, chess academies, music, dance, yoga, coding schools, and more.

🎯 What is Smart Academic Hub?​

Smart Academic Hub provides a complete ecosystem for managing educational institutions with:

  • Multi-tenant Architecture - Each academy operates independently with shared infrastructure
  • Unified Identity Management - Parents and staff can belong to multiple academies
  • Comprehensive Features - Student management, enrollments, attendance, fees, CRM, and more
  • Cross-Platform - Web (React), iOS, and Android (Expo) applications
  • API-First Design - RESTful API built with Laravel 12

🚀 Quick Links​

🏗️ Architecture​

┌─────────────────────────────────────────────────┐
│                   Frontend                       │
│            React + TypeScript + Vite             │
└─────────────────┬───────────────────────────────┘
                  │
                  │ HTTPS/REST
                  │
┌─────────────────▼───────────────────────────────┐
│                Backend API                       │
│            Laravel 12 + MySQL                    │
└─────────────────┬───────────────────────────────┘
                  │
                  │ HTTPS/REST
                  │
┌─────────────────▼───────────────────────────────┐
│               Mobile App                         │
│          Expo + React Native                     │
└─────────────────────────────────────────────────┘

📋 Key Features​

Phase 1 - Core Platform​

  • ✅ Authentication & Authorization
  • ✅ Academy Management
  • ✅ Student Management
  • ✅ Parent Management
  • ✅ Staff Management
  • ✅ Course Management
  • ✅ Enrollment System

Phase 2 - Operations​

  • 🔄 Attendance Tracking
  • 🔄 Fee Management
  • 🔄 CRM Features
  • 🔄 Lead Management

Phase 3 - Advanced Features​

  • 📅 Learning Management System (LMS)
  • 📅 Marketplace
  • 📅 AI Integration

🛠️ Technology Stack​

Backend​

  • Framework: Laravel 12
  • Language: PHP 8.2+
  • Database: MySQL 8.0+
  • Authentication: Laravel Sanctum
  • API: RESTful with versioning

Frontend​

  • Framework: React 18
  • Language: TypeScript
  • Build Tool: Vite
  • Styling: Tailwind CSS
  • State Management: Zustand + React Query

Mobile​

  • Framework: Expo
  • Language: TypeScript
  • Styling: NativeWind
  • Navigation: Expo Router

📖 Documentation Structure​

This documentation is organized into several sections:

  1. Getting Started - Installation, setup, and configuration
  2. Backend - Laravel API development guide
  3. Frontend - React web application guide
  4. Mobile - Expo mobile app guide
  5. Features - Feature-specific documentation
  6. API Reference - Interactive API documentation
  7. Deployment - Production deployment guides
  8. Contributing - Contribution guidelines

🤝 Contributing​

We welcome contributions! Please read our Contributing Guidelines before submitting pull requests.

📄 License​

This project is proprietary software. All rights reserved.

🆘 Getting Help​

Ready to get started? Head over to the Installation Guide!