AcademyMaster

Introduction

AcademyMaster is a user-friendly, open-source web application designed to streamline academic institution management. With a focus on simplifying managing courses, teachers, student activities, and enrollments.
The platform offers varying access levels for administrators, managers, teachers, and students to meet each user group's specific needs.

Backend

The backend of AcademyMaster is built using Django and Django REST Framework, incorporating modern technologies such as Docker, PostgreSQL, Redis, Celery, RabbitMQ, and Elastic Search. This solid technology stack ensures efficient data management and a smooth user experience. For detailed information about the AcademyMaster backend, please refer to the Backend Docs.

Frontend

The front-end of AcademyMaster is currently undergoing maintenance. We welcome contributions from front-end developers to help enhance and further develop the user experience.

How to Run

Follow these simple steps to run the AcademyMaster backend:

Using docker-compose

1. Clone the project repository:

   git clone https://github.com/mohamad-liyaghi/AcademyMaster.git

2. Change to the project directory:

   cd AcademyMaster/

3. To run the project in development mode using Docker-compose, execute the following command:

   docker-compose up --build

   If you want to run the project in production mode, use the following command instead:

   docker-compose -f docker-compose.prod.yml up --build

   This will build and start the containers required for the project to run in a production environment.

4. Access the AcademyMaster API in a web browser at http://localhost:8000/.

Using k8s

1. Clone the project repository:

   git clone https://github.com/mohamad-liyaghi/AcademyMaster.git

2. Change to the project directory:

   cd AcademyMaster/

3. Create ConfigMap

   make local_confmap

   or

     make prod_confmap

4. Creating Deployments

   kubectl apply -f ./kubernetes

5. For accessing backend API you need to edit service object on backend.yaml with preferred type for you cluster or use http://backend:8000/ on nodes

You can also load sample data by running the following command:

  make load_mock_data

You're all set! Enjoy using AcademyMaster to manage your academic institution with ease.