https://github.com/mohamad-liyaghi/academymaster

A comprehensive academy management api using django, celery, celery-beat, docker, kubernetes, redis, postgresql
https://github.com/mohamad-liyaghi/academymaster

celery django django-rest-framework docker-compose elasticsearch postgresql redis

Last synced: about 2 months ago
JSON representation

A comprehensive academy management api using django, celery, celery-beat, docker, kubernetes, redis, postgresql

• Host: GitHub
• URL: https://github.com/mohamad-liyaghi/academymaster
• Owner: mohamad-liyaghi
• Created: 2023-06-05T09:36:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-19T09:37:49.000Z (3 months ago)
• Last Synced: 2024-10-12T05:27:46.783Z (3 months ago)
• Topics: celery, django, django-rest-framework, docker-compose, elasticsearch, postgresql, redis
• Language: Python
• Homepage:
• Size: 410 KB
• Stars: 19
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](backend/README.md).

## 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:

    ```bash

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

    ```

2. Change to the project directory:

    ```bash

    cd AcademyMaster/

    ```

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

    ```bash

    docker-compose up --build

    ```

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

    ```bash

    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:

    ```bash

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

    ```

2. Change to the project directory:

    ```bash

    cd AcademyMaster/

    ```

3. Create ConfigMap 

    ```bash

    make local_confmap

    ```

    or

    ```bash

      make prod_confmap

   ```

4. Creating Deployments

    ```bash

    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:

```bash

  make load_mock_data

```

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