Skip to content

Commit

Permalink
Update Airtime module documentation and dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
dedanirungu committed Apr 9, 2024
1 parent a4ef4ec commit 8945d3b
Showing 1 changed file with 19 additions and 55 deletions.
74 changes: 19 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,29 @@
# MyBizna ERP - Airtime Management System
# MyBizna ERP - Airtime Module

## Overview
The Airtime Management System is a software application designed to facilitate the management and administration of a university or educational institution. This system provides a hierarchical structure for organizing the various components of the university, including airtime levels, faculties, schools, departments, programs, courses, class years, and students. It also incorporates the concept of qualifications for tracking academic achievements.
The Airtime module is an essential component of the MyBizna ERP system, designed to facilitate efficient management of airtime. This readme offers a brief overview of the module and guidance on how to start using it effectively.

## System Structure
The Airtime Management System follows a hierarchical structure for organizing the components of the university. The structure is as follows:
## Installation
To integrate the Airtime module into your MyBizna ERP system, execute the following composer command:

- **Airtime:** The top-level entity representing the university. It encompasses all the faculties, schools, departments, programs, courses, and students within the university.
```
composer require mybizna/airtime
```

- **Faculty:** Represents the major divisions within the university, such as the Faculty of Arts, Faculty of Science, Faculty of Engineering, etc. Faculties consist of various schools.
## Usage
The Airtime module offers a range of features for airtime purchase management. Some key functionalities include:
- **Airtime Purchase:** Easily purchase airtime for mobile devices.
- **Balance Management:** Keep track of airtime balance and usage.
- **Top-up Options:** Provide various top-up options for users to choose from.
- **Usage History:** View a history of airtime usage for analysis and tracking.
- **Auto-recharge:** Set up automatic airtime recharge for convenience.
- **Promotions and Discounts:** Offer promotions and discounts on airtime purchases.
- **Integration with Telecom Providers:** Integrate with telecom providers to facilitate seamless airtime management.
- **Reporting and Analytics:** Generate reports and analytics on airtime usage and trends.

- **School:** Refers to the intermediate units within a faculty, such as the School of Computer Science, School of Business, School of Medicine, etc. Schools consist of different departments.

- **Department:** Represents the specific departments within a school, such as the Department of Computer Science, Department of Economics, Department of Biology, etc. Departments are responsible for offering programs.
To leverage these features, access the MyBizna ERP application and navigate to the Airtime module. Explore the available options to effectively manage and organize your organization's schedule.

- **Program:** Refers to the academic programs offered by a department, such as Bachelor of Science in Computer Science, Master of Business Administration, Bachelor of Arts in English Literature, etc. Programs consist of multiple courses.

- **Courses:** Represents the individual courses offered as part of a program. Examples include Introduction to Programming, Financial Accounting, Organic Chemistry, etc. Courses are offered in different class years.

- **ClassYear:** Represents the specific class years within a program, such as the first year, second year, third year, etc. Each class year consists of enrolled students.

- **Student:** Represents the individual students enrolled in a class year. Each student has a set of qualifications representing their academic achievements.

- **Qualification:** Refers to the academic qualifications achieved by a student, such as diplomas, degrees, certificates, etc. Qualifications are associated with specific programs and indicate the student's completion of specific requirements.
```
Airtime
|
Faculty
|
School
|
Department Qualification
| |
------ Program ------
|
----------------------
| |
Learner Courses
| |
----------------------
|
ClassYear
## Functionality
The Airtime Management System provides the following functionality:
- **Hierarchy Management:** Enables the creation, modification, and deletion of airtime levels, faculties, schools, departments, programs, courses, class years, students, and qualifications.
- **Enrollment:** Allows for the enrollment of students in specific class years and programs.
- **Course Management:** Facilitates the creation, modification, and deletion of courses within programs.
- **Qualification Tracking:** Enables the tracking of qualifications earned by students and their association with specific programs.
- **Reporting:** Provides various reports and statistics on student enrollment, program completion, course offerings, etc.
## Requirements
## Requirements
Mybizna ERP version 1.0 or above

## Support
Expand All @@ -67,6 +34,3 @@ If you're interested in contributing to this project, please reach out to the te

## License
This project is licensed under the GPL-3.0-or-later.

0 comments on commit 8945d3b

Please sign in to comment.