KIIT-Faculty-Review

Overview

KIIT-Faculty-Review is an open-source, full-stack web application built using MERN stack to empower university students by facilitating the collection and sharing of professor reviews, ultimately aiding in informed section selection.

Features

Review Submission: Students can anonymously submit reviews for professors and their sections.

Review Display: Submitted reviews are displayed publicly on the website, categorized by professor and section.

Filtering (Coming Soon): Students can filter reviews by professor, course, or keyword to find relevant feedback.

Search(Coming Soon): Students can search for specific professors or courses to find reviews.

Technology Stack

Frontend: React.js

Backend: Express.js

Database: MongoDB

Build

• Clone the repository:

  git clone https://github.com/your-username/ProfessorReview.git
  cd ProfessorReview
  npm install

• Create a .env file in the project root directory.
  • Add your database connection details to the .env file following the specific format required by your chosen database library.
• Launch Development Server

  npm run dev

  This will launch the frontend development server and make the application accessible at http://localhost:5173 .

  cd server
  tsc
  node dist/index.js

  This will launch the backend development server and make the application accessible at http://localhost:3000 .

Contribution

We encourage contributions to this project!

• Fork the repository.
• Create a new branch for your feature or bug fix.
• Implement your changes and write unit tests (if applicable).
• Submit a pull request for review.

License

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