MyCollege

MyCollege - A Notes and updates App for NIT KKR studensts. All branchs notes and study material, send push notifications of updates from NIT KKR.

Application Features

• Login via Mobile with OTP verification
• All branchs notes and study material (updating soon...)
• Search notes and study material
• Show all updates from NIT KKR website (https://nitkkr.ac.in)
• Send push notifications on updates from NIT KKR
• Upload Notes feature, directly uploads the study material on my google drive

Website Link: MyCollege

Tech Stack

• React
• Redux
• Tailwind CSS
• Twillio (For sending OTP)
• Cookies
• Nodejs
• Express.js
• Cheerio (For scrapping NIT KKR's website)
• MongoDB

Client Side

npm install

Install modules mentioned in package.json

Create .env

Create a .env file at the root of client directory and add REACT_APP_SERVER_BASE_URL2 = <Your Backend Url> and REACT_APP_ONESIGNAL_APPID = <Your ONE SIGNAL Account ID>

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Server Side

npm install

Install modules mentioned in package.json

npm start

Runs the app in the development mode.
Open http://localhost:8000 to run server.

You will also see any errors or information in the console.

Screenshots

Lighthouse Stats