Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
justafolk authored Jul 13, 2023
1 parent 3a6dd17 commit e678569
Showing 1 changed file with 59 additions and 1 deletion.
60 changes: 59 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,62 @@
# Grade-Point-Average-Analyzer
# Grade Point Average Analyzer

The Grade Point Average Analyzer is a project developed using Flask, Python, HTML, and CSS. It serves as a helpful tool for students to maintain and track their academic data across semesters and courses. With this application, students can easily organize their grades, calculate their grade point averages (GPAs), and monitor their academic progress.

## Project Overview

The Grade Point Average Analyzer provides the following features:

- Create and manage multiple semesters.
- Add and update courses within each semester.
- Record and track grades for each course.
- Calculate cumulative GPA based on the entered grades.
- View semester-wise and overall GPA summaries.
- Generate reports and visualize academic performance.

## Tech Stack

- Flask: version X.X
- Python: version X.X
- MySQL
- HTML
- CSS

## Installation and Setup

To set up the Grade Point Average Analyzer on your local environment, please follow these steps:

1. Clone the project repository:

```bash
git clone https://github.com/justafolk/Grade-Point-Average-Analyzer
```
2. Install the required dependencies:
```bash
pip install -r requirements.txt
```
3. Import the database:
- Create a MySQL database named "gpa".
- Import the provided SQL file to the "gpa" database.

## Usage

1. Sign up for a new account or log in if you already have one.
2. Create a new semester and add courses to it.
3. Enter the grades for each course.
4. View your semester-wise and cumulative GPA calculations.
5. Explore additional features such as reports and visualizations.

## Contributors

This project is contributed to and maintained by the following individuals:

1. [Your Name](https://github.com/your-username)
2. [Contributor Name 1](https://github.com/contributor1)
3. [Contributor Name 2](https://github.com/contributor2)
4. [Contributor Name 3](https://github.com/contributor3)

Feel free to contribute to this project by submitting


![image](https://github.com/justafolk/Grade-Point-Average-Analyzer/assets/65607123/41c4d297-188d-4106-965e-5d4d08660369)

Expand Down

0 comments on commit e678569

Please sign in to comment.