Skip to content

Latest commit

Β 

History

78 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸŽ“ LIYNMAR Online Tutorial Services

Complete Tutorial Management System with Role-Based Access Control

A comprehensive web application for managing teachers, students, bookings, sessions, and revenue tracking for LIYNMAR Online Tutorial Services with multi-user access control.

Status React Node.js MongoDB License


πŸ“š Quick Links


✨ Features at a Glance

πŸ” Role-Based Access Control (NEW!)

  • Admin (Owner): Full system access
  • Teacher Manager: Manages teacher profiles and information
  • Booking Manager: Handles bookings and student management
  • Visual lock indicators for restricted sections
  • Secure backend middleware protection

πŸ‘₯ Employee Management (NEW!)

  • Create and manage employee accounts
  • Assign specific roles with limited access
  • View all employees in organized table
  • Filter by role type (Teacher Manager, Booking Manager)
  • Track deleted accounts

πŸ“Š Dashboard

  • Comprehensive analytics with 4 interactive graphs
  • Revenue tracking (Week/Month/Year)
  • Session completion statistics
  • Top teachers and subjects ranking
  • Real-time metrics

πŸ‘¨β€πŸ« Teachers Management

  • Complete teacher profiles with contact info
  • Weekly student schedule tracking
  • Interactive session status management (C/A/P/T/S/N)
  • Automatic earnings calculation with company share
  • Active/Inactive status tracking
  • Soft delete with restore functionality

πŸ“… Booking System

  • Flexible booking form with real-time summary
  • Different times and durations per day
  • Student and parent information capture
  • Weekly total calculation
  • Seamless integration with teacher profiles

πŸŽ“ Students Management

  • Comprehensive student profiles
  • Parent/Guardian information tracking
  • Academic progress monitoring
  • Teacher assignment tracking

πŸ” Smart Search

  • Context-aware search across all pages
  • Multi-field filtering
  • Real-time results

πŸš€ Quick Start

Prerequisites

  • Node.js 14+
  • npm or yarn

Installation

# Navigate to client directory
cd liynmar-app/client

# Install dependencies
npm install

# Start development server
npm run dev

Open http://localhost:5173 in your browser.


πŸ› οΈ Tech Stack

Frontend

  • React 18 - UI library
  • React Router - Navigation
  • React Query - Data fetching & caching
  • Vite - Build tool
  • CSS3 - Styling with custom variables
  • Font Awesome - Icons

Backend (Ready for Implementation)

  • Node.js - Runtime environment
  • Express - Web framework
  • MongoDB - NoSQL database
  • Mongoose - ODM
  • JWT - Authentication

πŸ“ Project Structure

liynmar-app/
β”œβ”€β”€ client/
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ components/
β”‚   β”‚   β”‚   └── Layout/
β”‚   β”‚   β”‚       β”œβ”€β”€ Header.jsx         # Top navigation
β”‚   β”‚   β”‚       └── Sidebar.jsx        # Side navigation
β”‚   β”‚   β”œβ”€β”€ pages/
β”‚   β”‚   β”‚   β”œβ”€β”€ Dashboard.jsx          # Analytics & graphs
β”‚   β”‚   β”‚   β”œβ”€β”€ Teachers.jsx           # Teacher list
β”‚   β”‚   β”‚   β”œβ”€β”€ TeacherProfile.jsx     # Teacher details & sessions
β”‚   β”‚   β”‚   └── Bookings.jsx           # Booking management
β”‚   β”‚   β”œβ”€β”€ services/
β”‚   β”‚   β”‚   β”œβ”€β”€ teacherService.js      # Teacher API
β”‚   β”‚   β”‚   └── bookingService.js      # Booking API
β”‚   β”‚   β”œβ”€β”€ context/
β”‚   β”‚   β”‚   └── AuthContext.jsx        # Authentication
β”‚   β”‚   └── App.jsx
β”‚   └── package.json
β”œβ”€β”€ server/                             # Backend (to be implemented)
β”œβ”€β”€ FEATURES.md                         # Complete documentation
β”œβ”€β”€ QUICKSTART.md                       # Setup guide
β”œβ”€β”€ SESSION_STATUS_GUIDE.md            # Status reference
└── README.md                           # This file

🎯 Key Features

Session Status Management

Interactive status tracking with 6 codes:

  • C - Completed & Paid βœ… (Counted)
  • A - Advance Paid βœ… (Counted)
  • P - Pending ❌ (Not counted)
  • T - Teacher Absent ❌ (Not counted)
  • S - Student Absent ❌ (Not counted)
  • N - No Schedule ❌ (Not counted)

Flexible Scheduling

  • Different times for each day
  • Variable durations (30 min - 2 hours)
  • Automatic rate calculation
  • Real-time booking summary

Comprehensive Analytics

  • Revenue trend graphs
  • Session completion statistics
  • Subject popularity tracking
  • Teacher performance ranking

πŸ“– Documentation

For Users

  1. QUICKSTART.md - Get started quickly
  2. SESSION_STATUS_GUIDE.md - Understanding status codes
  3. FEATURES.md - Detailed feature list

For Developers

  1. IMPLEMENTATION_SUMMARY.md - What was built
  2. FEATURES.md - Technical specifications
  3. Inline Code Comments - Component documentation

🎨 Screenshots

Dashboard

Analytics overview with 4 interactive graphs showing revenue, sessions, subjects, and top teachers.

Teacher Profile

Detailed profile with contact info and weekly student schedule with interactive status management.

Booking Form

Comprehensive booking form with flexible scheduling and real-time summary.


πŸ”§ Configuration

Customizing Colors

Edit client/src/index.css:

:root {
  --color-primary: #8B7355;      /* Main brand color */
  --color-secondary: #C9A869;    /* Accent color */
  /* ... more variables */
}

Changing Hourly Rate

Default rate is β‚±125/hour. Update in:

  • client/src/pages/Bookings.jsx (sample data)
  • Backend API when implemented

πŸš€ Deployment

Frontend (Vite)

cd client
npm run build
# Deploy 'dist' folder to hosting service

Backend Setup (When Ready)

Refer to QUICKSTART.md for:

  • API endpoint structure
  • Database schema
  • Authentication setup

πŸ“Š System Requirements

Minimum

  • Node.js 14.x
  • 2GB RAM
  • Modern browser (Chrome, Firefox, Edge, Safari)

Recommended

  • Node.js 18.x
  • 4GB RAM
  • Latest browser version

🀝 Contributing

This is a private project for LIYNMAR Online Tutorial Services. For changes or improvements, contact the development team.


πŸ“„ License

Private and proprietary. All rights reserved by LIYNMAR Online Tutorial Services.


πŸ†˜ Support

Getting Help

  1. Check the documentation files
  2. Review inline code comments
  3. Contact the development team

Common Issues

See QUICKSTART.md Troubleshooting section.


πŸŽ“ About LIYNMAR

LIYNMAR Online Tutorial Services provides quality online education with experienced teachers across multiple subjects. This system helps manage operations efficiently.


πŸ“ž Contact

For questions or support:

  • Technical Issues: Check documentation
  • Feature Requests: Contact development team
  • General Inquiries: LIYNMAR administration

Built with ❀️ for LIYNMAR Online Tutorial Services

Empowering Education Through Technology

  • βœ… Teachers management with availability tracking
  • βœ… Teacher profiles with student schedules
  • βœ… Payment status tracking
  • βœ… Old money aesthetic design
  • 🚧 Backend API (in progress)
  • 🚧 Database integration (in progress)
  • 🚧 Authentication (in progress)

Design

The application features an elegant "old money" aesthetic with:

  • Primary: Warm Taupe (#8B7355)
  • Secondary: Antique Gold (#C9A869)
  • Background: Cream (#F5F3EF)
  • Fonts: Playfair Display & Lato

License

Private - LIYNMAR Online Tutorial Services

Releases

Packages

Contributors

Languages