Skip to content
This repository has been archived by the owner on May 26, 2020. It is now read-only.

Home

Jump to bottom
Danny Hanna edited this page Nov 27, 2018 · 5 revisions

What is Educational Inequality?

Educational inequality is defined as "the unequal distribution of academic resources to socially excluded communities." This unfairness typically stems from many factors, such as wealth and location, but one significant commonality exists; often times, students who live with some form of educational inequality will find school to be increasingly difficult, which in turn could lead to an increasing amount of "drop-outs" for that area.

So What Does Brain Wave Have to do With It?

Brain Wave is a project that attempts to address the social issue of educational inequality. It aims to become a website that acts as a “hub” of various supplemental tools and aid for students who study or go to school in areas that have an unequal distribution of academic resources. By providing a plethora of resources, such as methods for studying, guides to follow when faced with academic challenges, and organizational tips, students can feel better and more confident about academics; they could feel happier, less stressed, less likely to drop-out, and more excited for their scholarly pursuits.

Running the Application

This application will require an installation/environment that is similar to any other Rails based application

  1. Ensure that Ruby version 2.5.1 is installed on the machine
  2. Ensure that Rails version 5.2.1 is installed on the machine
  3. Navigate to the brainWave code folder. Run bundle install to insure that all of the required dependencies are installed. Note that pg version 1.1.3 is required.
  4. Once all dependencies are installed, run rails s
  5. Use any browser to view the application. Navigate to http://localhost:3000
  6. This application is intended to work with any web browser on any operating system. There are currently no known browsers with compatibility issues.

Documentation

Note: All documents referenced here can be found in the docs folder of this repository.

Project Proposal: Contains project proposal as it currently stands

Proposal Revisions: Contains a list of any changes that were made to the Project Proposal.

Use Case Descriptions: Contains a detailed description set of the use cases defined for the project.

UI Screen Mockups: A document depicting the User Interface Screens as they would appear in the application.

UI Adherence: Document explaining the correlation between the UI Mockups and the Eight Golden Rules of UI Design

State Chart Diagram: Diagram depicting the behavior of the system via a state chart.

System Sequence Diagram: Diagram depicting the behavior of the system via a system sequence diagram.

Design Class Diagram: Diagram utilized to model the structure of the system.

Test Case Design: Documentation explaining the various methods that will be used to approach system testing.

Adherence to Requirements: Documentation explaining how the overall system design adheres to project requirements.

Clone this wiki locally