Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 2.86 KB

README.md

File metadata and controls

52 lines (30 loc) · 2.86 KB

Knowledge Sharing Platform 🗒

Knowledge sharing platform application aims to get the students acquainted with the courses, professors, and evaluation schemes. The said things can be achieved via gathering course feedback, professor feedback, and previous year grading schemes. This can be done by making a portal (just like a blog site) where people can share their honest reviews without being scrutinized much. Getting reviews from the masses makes it easy for one to choose a particular course and get the right information about that course. Crowd-sourcing of materials and feedback would make it easy to organize resources in one place. It would be more reliable, save one’s time, and avoid unnecessary bothering. Moreover, students can also get relevant course resources from the students who already opted for the course. This platform can also act as a general guidance portal.

Techstack 👩‍💻

NextJS, TailwindCSS

Maintainers ☀️

@JaeAeich @AryaLanjewar3005

Other details 📑

This project is in its second iteration. We might have NodeJS as the backend. In the future, might do clustering of students on the basis of the course taken.

Contribution Guidelines ✨

Please go through the Wiki. The success of our vision to bring knowledge to every single hand depends on you. Even a small contribution helps. All forms of contributions are highly welcomed and valued.

Set up the project 💻

Environment Variables

Make a .env with the same fields in .env.example.

  • For the database, you can use the Postgres database of Supabase. The connection string can be found in the project settings of the database, as shown in the picture below: Supabase Connection String

  • NEXT_PUBLIC_API_KEY, NEXT_PUBLIC_AUTH_DOMAIN NEXT_PUBLIC_PROJECT_ID, NEXT_PUBLIC_STORAGE_BUCKET NEXT_PUBLIC_MESSAGING_SENDER_ID, NEXT_PUBLIC_APP_ID NEXT_PUBLIC_MEASUREMENT_ID These variables can be found in the Firebase Project Settings, after creating a web app in Firebase. Firebase App Settings

  • TYPE, PROJECT_ID, PRIVATE_KEY_ID, PRIVATE_KEY='{"privateKey":""}', CLIENT_EMAIL, AUTH_URI, TOKEN_URI These variables can be found in the Service Accounts section of Project Settings of the app by clicking on Generate new private key. Firebase Admin Settings

Install the dependencies

npm i

Run the server

npm run dev