Classroom Stats Visualizer

Problem Statement

K-12 educators need to be able to analyze a large set of data gathered from their classroom for determining the correct learning path for the class. Since the educators are currently looking at data from a table perspective, they are spending more time deciphering the data instead of planning the next learning activity. This is also a problem for the students, since educators are less focused on catering to their learning.

Solution Statement

The goal of Classroom Stats Visualizer is to analyze and determine a performance metric for each student given the student’s grades. This performance metric will allow for teachers to quickly determine which students are in need of assistance. Also, Classroom Stats Visualizer will provide teachers with the ability to dive deeper into each individual student. This deep dive will display the student’s performance metric along with generating visual aids based on student grades over the semester.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. License
5. Contact

About The Project

Built With

• Django
• Bootstrap
• JQuery
• Oracle Instant Client

(back to top)

Getting Started

Prerequisites

• Latest version of Python

(back to top)

Installation For Visual Studio Code (Windows)

1. Clone the repo

   git clone https://github.com/andrewkrawczyk/ClassroomStatsVisualizer

2. Generate Virtual Environment (~/ClassroomStatsVisualizer)

   py -3 -m venv .venv

3. Activate Environment

   .venv\scripts\activate

4. Move Directory

   cd .\DjangoWebProject 

5. Install Requirements

   pip3 install -r requirements.txt

(back to top)

Installation For Instant Client (Windows)

1. Get a free Oracle wallet by emailing (blank)
2. Download the basic package (version 21.3) from the following link: https://www.oracle.com/database/technologies/instant-client/downloads.html
3. Unzip and place in the following directory

   C:\oracle\

4. Place the wallet into

   C:\oracle\instantclient_21_3\network\admin

Running App For Visual Studio Code (Windows)

1. Unzip and place in the following directory

   python manage.py runserver

(back to top)

Installation For Visual Studio Code (macOS)

1. Clone the repo

   git clone https://github.com/andrewkrawczyk/ClassroomStatsVisualizer

2. Generate Virtual Environment (~/ClassroomStatsVisualizer)

   python3 -m venv .venv 

3. Activate Environment

   source .venv/bin/activate

4. Move Directory

   cd DjangoWebProject 

5. Install Requirements

   pip3 install -r requirements.txt

(back to top)

Installation For Instant Client (macOS)

1. Get a free Oracle wallet by emailing (blank)
2. Download the basic package (version 19.8) from the following link: https://www.oracle.com/database/technologies/instant-client/downloads.html
3. Unzip and place in the following directory

   ~/Downloads/instantclient_19_8

4. Place the wallet into

   ~/Downloads/instantclient_19_8/network/admin

(back to top)

Running App For Visual Studio Code (macOS)

1. Unzip and place in the following directory

   python3 manage.py runserver

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

CEN 3031: Group 6 - placeholder@comcast.net

Project Link: https://github.com/andrewkrawczyk/ClassroomStatsVisualizer

(back to top)