Maxedu

Welcome to the documentation for Maxedu. This documentation is organized into several sections to help you understand the project architecture, modules, features, and setup process.

Install Maxedu

bench get-app https://github.com/weloin-sudipta/maxedu

Add the Frappe Gems badge to your README

Maintain Maxedu? Paste this into your README:

[![Listed on Frappe Gems](https://frappegems.com/api/method/frappe_gems.seo.badge?app=weloin-sudipta%2Fmaxedu)](https://frappegems.com/gems/apps/weloin-sudipta/maxedu)

About Maxedu

Project Documentation

Welcome to the documentation for Maxedu. This documentation is organized into several sections to help you understand the project architecture, modules, features, and setup process.

Sections

Overview

Introduction to the project, its vision, mission, target users, and the problem it aims to solve. - Project Introduction - Vision & Mission - Target Users - Problem Statement

Architecture

Detailed information about the system design, tech stack, and multi-tenant implementation. - System Architecture - Tech Stack - Multi-tenant Design - Database Design

Modules

Functional breakdown of the application modules. - Institute Management - User & Role Management - Student Management - Course Management - Routine Generator - Library System - Recommendation System

Features

Listing of core, advanced, and AI-driven features. - Core Features - Advanced Features - AI Features

API Documentation

API endpoints and authentication details. - Authentication - Institute API - Student API - Recommendation API

Setup & Installation

Instructions for setting up the development and production environments. - Installation Guide - Environment Setup - Frappe Setup - Future Docker Setup

Development Guide

Coding standards, folder structure, and naming conventions. - Coding Standards - Folder Structure - Naming Conventions - Git Workflow

Database

ER diagrams and table relationships. - ER Diagram - Tables - Relationships

Roadmap

Project timeline, MVP plans, and future scope. - MVP Plan - Feature Roadmap - Future Scope

Related Other apps for Frappe & ERPNext

  • Erpnext — Free and Open Source Enterprise Resource Planning (ERP)
  • Helpdesk — Modern, Streamlined, Free and Open Source Customer Service Software
  • Print Designer — Visual print designer for Frappe / ERPNext
  • Ctr — CTR模型代码和学习笔记总结
  • Whitelabel — Whitelabel ERPNext
  • Fossunited — fossunited.org
  • Helm — Helm Chart Repository for Frappe/ERPNext
  • Frappe Attachments S3 — A frappe app to upload file attachments in doctypes to s3.