Proffinder is a platform I built as project for my engineering exploration subject in college. Proffinder is built using the MERN stack and is a medium-sized project.
Proffinder is a platform which lets students input a 3 queries, the professor/faculty name, the day and the time slots which will then display their location (text-format) and their current status Proffinder is especially useful for large institutions where navigation can often be touch, or for freshers who are not aware of faulty locations. Proffinder implements authentication for faculty through JWT (Json Web Tokens). Which lets faculty login, upload a timetable and set a current status which will be displayed for selected slots.
Client
- To run this project, first run this command:
git clone https://github.com/Goldfish7718/proffinder.git
- Now run
cd client-production
and create a .env file and pass one environment variable:VITE_API_URL=http://<API_URL>
. Replace<API_URL>
with actual API URL - Now run 2 commands:
npm install
npm start
Server
-
First cd into the server folder with the following command:
cd server
-
Now create a .env file and pass 2 Environment variables in it as follows:
a.JWT_SECRET=<ANY_STRING>
. Replace<ANY_STRING>
with any string you wish.
b.db_URI=<YOUR_DB_CONNECTION_STRING>
. Replace<YOUR_DB_CONNECTION_STRING>
with your actual MongoDB connection string. -
Now install dependencies and start the server
npm install
npm start
- You should see the following message in the terminal. (You can change the port number if you want). You can also pass a
PORT
environment variable if you wish.
Server started at port 5000
Congratulations! You've successfully started both the servers
The timeslots in this project are as per my college's timetable. You may adjust it accordingly in the controllers folder
- For any queries, please contact me on my email: tejasnanoti2@gmail.com
- This project is licensed under the MIT License.