Skip to content

README.md

Latest commit

 

History

History
85 lines (62 loc) · 3.76 KB

README.md

File metadata and controls

85 lines (62 loc) · 3.76 KB

College Database Management System using Django

This project is a web application built using Django, aimed at improving the efficiency and organization of college records. The web application provides a user-friendly interface to manage various aspects of college records, including student information, course schedules, and faculty details.

Table of Contents

Introduction

College records can be complex and cumbersome to manage. With this web application, we aim to simplify the process of managing college records by providing a comprehensive and user-friendly solution. The application provides a centralized database management system for student and faculty data, course schedules, and other college-related information.

Features

This college database management system offers the following features:

  • Manage student information, including personal details, academic records, and attendance history
  • Manage faculty details, including personal information, teaching assignments, and performance evaluations
  • Manage course schedules, including class timings, course content, and exam schedules
  • Generate reports and analytics on student and faculty performance, attendance records, and other metrics
  • Administer user access and privileges to ensure data security and privacy
  • Customize user interface and settings to suit individual preferences and workflows

Technologies Used

This project was built using the following technologies:

  • Python
  • Django
  • Gunicorn
  • Nginx
  • Google Kubernetes Engine (GKE)

Installation

To run this project locally, follow these steps:

  1. Clone the repository using the command git clone https://github.com/KryptonGuy/college-management-system.git
  2. Navigate to the project directory using the command cd college-management-system
  3. Create a virtual environment using the command python -m venv venv
  4. Activate the virtual environment:
    • On Windows: venv\Scripts\activate
    • On Unix or Linux: source venv/bin/activate
  5. Install the required dependencies using the command pip install -r requirements.txt
  6. Set up your database configuration in the settings.py file.
  7. Run the application using the command python manage.py runserver

Usage

To use this web application, follow these steps:

  1. Ensure the application server is running by executing python manage.py runserver.
  2. Open your web browser and navigate to http://localhost:8000 to access the application.
  3. Use the navigation menu to access different sections of the application.
  4. Refer to the application documentation for detailed instructions on how to use each section.

Deployment

To deploy this web application to a GKE cluster, follow these steps:

  1. Set up a GKE cluster using the Google Cloud Console.
  2. Create a Kubernetes deployment YAML file for the Django application.
  3. Create a Kubernetes service YAML file for the Django application.
  4. Create a Kubernetes deployment YAML file for the Gunicorn server.
  5. Create a Kubernetes service YAML file for the Gunicorn server.
  6. Create a Kubernetes ingress YAML file for the Nginx server.
  7. Apply the YAML files to the GKE cluster using kubectl apply.

Contributing

We welcome contributions from the community. If you would like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes and commit them.
  4. Push your changes to your fork.
  5. Submit a pull request.