RUCS Hub - www.rucshub.com

RUCS Hub is a platform designed for Rutgers students to anonymously review and rate their courses and professors.

This project aims to empower students by providing them with valuable insights into the courses and professors offered at Rutgers. RUCS Hub helps students make informed decisions about their course selections and academic paths.

RUCS Hub is an independent project and is not directly affiliated with Rutgers University.

Table of Contents

• Features
• Usage
• Installation
• Contributing
• Contact
• License

Features

• Anonymous Reviews: Students can review and rate courses and professors anonymously.
• Student Authentication: Uses student emails for authentication to ensure that only Rutgers students can post reviews.
• Course & Professor Ratings: View aggregated ratings and reviews for courses and professors.
• Search & Filter: Easily search for and filter courses and professors based on various criteria.
• Upvote/Downvote Reviews: Users can upvote or downvote reviews to highlight the most helpful ones.
• Subscribe to Courses & Professors: Recieve notifications when a course or professor you are subscribed to recieves a new review.
• Report Reviews: Users can report inappropriate or offensive reviews for moderation.

Usage

1. Sign up or log in using your Rutgers student email.
2. Browse courses and professors to read reviews and ratings.
3. Submit your own reviews for courses and professors you’ve taken.
4. Upvote or downvote reviews to indicate their helpfulness.
5. Report reviews that violate the terms of use.

Installation

To get started with the project, follow these steps:

1. Clone the repository:

git clone https://github.com/DylanPina/RUCS-Hub.git
cd rucs-hub

2. Install the dependencies

npm install

3. Run the development server

npm run dev

4. Open your browser and navigate to http://localhost:3000

Setting Up the Development Environment

1. Set up the development environment variables: Copy the .env.example to .env. This will set up the development database and auth0 connection. Note that this is completely separate from the production environment and database.

cp .env.example .env

2. Generate the Prisma client:

npx prisma generate

Contributing

To contribute to RUCS Hub, follow these steps:

1. Create an issue on the repo: https://github.com/DylanPina/RUCS-Hub/issues.
2. Assign yourself (or someone else) to the new issue.
3. Copy the repo.
4. On your local machine, first git pull then switch to the new branch:

git pull
git checkout -b feature/your-feature

5. Make your changes and commit them:

git add .
git commit -m "Your commit message"

6. Push your changes to the RUCS Hub repo:

git push

7. Create a PR on the repo: https://github.com/DylanPina/RUCS-Hub/pulls.
8. Get signoff from the required reviewers and merge the changes.
9. The repo owner will deploy the changes once the PR is merged.

Contact

For questions or to reach out, join our Discord server: https://discord.gg/bc2yDRVs, or email us at [email protected].

License

This project is licensed under the Apache License 2.0. See the LICENSE file for details.