Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.25 KB

readme.md

File metadata and controls

36 lines (22 loc) · 1.25 KB

RateMyProf

RateMyProf is an open source web app made with express, mongoDB and React where you can rate your professors. You can clone this repository and make up your own database of professors to get started.

PS: This was my first project. Sorry for bad code quality. 😿

Installation

Clone this repository and run these npm commands to get started.

npm install
npm run dev

But before that make sure you set up the following in your environment variables.

Environment Variables

Below are the required variables that must be set up before you fire up the project:

  • PORT = 5000 Optional
  • MONGODB_CRED = Your mongoDB URI
  • JWT_SECRET = Anything Secret
  • email = Your Gmail address
  • clientId, clientSecret, refresh_token provided by Google

Visit OAuth Playground for the last three variables. Get more help with the last step on Medium.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT