- Install nodejs and npm on your device.
- Clone the repository to your local system.
- In the root folder, create a '.env' file.
- Create a MongoDB server and get the MongoDB URI.
- Add env variables as "MONGO_URI" to the .env file
- Add a PORT variable and JWT_SECRET variable too.
- Set PORT = 5000
- Set JWT_SECRET as a string of your choice.
-
Open up the command terminal from the root directory and type
npm start
to start the backend server. -
Open another command prompt and type the following to start the frontend.
cd frontend
npm run dev
-
The application would be run on http://127.0.0.1:5173/
-
An admin user will be created in the database
Email : admin@nitk.edu.in
Password: admin123
- Register and Login User
- Each user gets a unique avatar
- Users can only register with NITK email id
- Different roles like Admin, Internship Coordinator, Placement Coordinator and User.
- List of categories with ability to add and delete category for the admin
- List of Users with their information
- Admin can change allowed categories for each user and handle their roles and status.
- Internship and Placement coordinators can edit the User status.
- User Dashboard where a user can see the categories he can write about and the gyans he has already wrote.
- List of Gyans
- Seperate page for each Gyan with an accordion
- Forms to add and edit gyans
- Pagination on the Gyan Page
- Filtering based on category and User branch
- User authentication with Google OAuth
- Better and responsive UI
- Charts to show metadata about the gyans
- Dark mode
- More filtering options
- The pagination only lets the filter to apply on the current Gyans being rendered on the page.
- On deleting a category, a question or a user, the documents in which they were refered are not deleted. This renders them as null on populating from the database and breaks the application.
- On smaller screen, the UI breaks
- A user should be able to write a single gyan and each topic but he can write multiple of them.
- Stack Overflow
- LogRocket blog
- Tailwind CSS docs
- W3School
- Jason Watmore's blog
- Mongoose JS docs
- Formik docs
- Medium articles
Register Form
Login Form
User List
User Details (1)
User Details (2)
Edit User Form
List of Questions in a category
User Dashboard (1)
User Dashboard (2)
Single Gyan
CREDITS: Harshit Gupta