Rotten Classes - Project Repository

Product Vision Statement

Rotten Classes allows students to rate their own class experiences and view ratings of classes made by other students. Rotten Classes is an easy-to-use web-application that allows students to discover the courseload and course dynamics of a particular class for when the provided course description is not informative enough.

At first glance, students can:

• See numeric, visual, and written reviews of a course.
• Review a course of their own.
• Search for a course or filter search options to find a course they're interested in.

As Rotten Classes develops, students can:

• Bookmark courses that they are interested in.
• View courses that are loved by other students.
• Contact support for any problems that may arise when using the application.

Core Team Members

• Alaa Al Shaba
  • Github
• Ashley Luo
  • Github
• Ronit Singh
  • Github
• Sonia Jain
  • Github

Sprint Roles

Sprint 0

Product Owner

• Sonia Jain

Scrum Master

• Ashley Luo

Developers

• Alaa Al Shaba
• Ashley Luo
• Ronit Singh
• Sonia Jain

Sprint 1

Product Owner

• Sonia Jain

Scrum Master

• Ashley Luo

Developers

• Alaa Al Shaba
• Ashley Luo
• Ronit Singh
• Sonia Jain

Sprint 2

Product Owner

• Ronit Singh

Scrum Master

• Alaa Al Shaba

Developers

• Alaa Al Shaba
• Ashley Luo
• Ronit Singh
• Sonia Jain

Sprint 3

Product Owner

• Alaa Al Shaba

Scrum Master

• Sonia Jain

Developers

• Alaa Al Shaba
• Ashley Luo
• Ronit Singh
• Sonia Jain

Sprint 4

Product Owner

• Ashley Luo

Scrum Master

• Ronit Singh

Developers

• Alaa Al Shaba
• Ashley Luo
• Ronit Singh
• Sonia Jain

Collaboration and Contribution

Please read our CONTRIBUTING.md document outlining our team norms, git workflow, rules on how and what to contribute, instructions for setting up the local development environment, and steps on how to build and test our app.

Project Instructions

Setting Up

GitHub repository will provide the latest tested version of our project. To set up a project on the computer, you need to:

1. Click here to install VSCode.
2. In order to run this application, please clone the project repository into your VSCode project using git clone.
   • git clone https://github.com/some-username/my-app.git
3. This will create a new directory on your local machine where all the files for this application will be stored.
4. After you have cloned the repository, navigate to that directory using terminal.

Front-end

• Navigate to the front-end file using cd front-end.
• Resolve the Material UI and npm conflict first using npm config set legacy-peer-deps true.
• Install npm using command npm install.
• Run npm using npm start.
• You should then be navigated to a browser where you could view our applicaion.

Back-end

• Navigate to the back-end file using cd back-end.
• Now you can install express using npm install express --save and nodemon using npm i nodemon --save-dev and multer using npm install multer.
• Use npm run dev to run the express app.
• Now go to the browser and run localhost:4000.

Back-end Testing

• Navigate to the back-end file using cd back-end.
• Begin testing all back-end code using npm test.

Database Connection

• Navigate to the back-end file using cd back-end.
• Create an .env file
• Inside the .env file, create DB_USERNAME="credential", DB_PASSWORD="credential", DB_URL="credential".
• The credential will be given in our discord channel.

Deployment

• Project Public Link: http://161.35.101.19/
• Happy Coding!