Skip to content

Commit

Permalink
Merge pull request #36 from OpenLake/JaeAeich-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
tusharbansal22 authored Sep 30, 2023
2 parents d5a4576 + 1a57c9a commit d2067c2
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# Knowledge Sharing Platform 🗒

Knowledge sharing platform application aims to get the students acquainted with the courses, professors, 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 mass makes it easy for one to choose the particular course and get the right information about that course. Crowd-sourcing of materials and feedback would make it easy to organize resources at 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.
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 ☀️

| [@Ananya](https://github.com/Ananyaiitbhilai) | [@Anshuman Dhiman](https://github.com/AnshumanDhiman) |
| [@JaeAeich](https://github.com/JaeAeich) | [@AryaLanjewar3005](https://github.com/AryaLanjewar3005) |
| --------------------------------------------- | ----------------------------------------------------- |

## Other details 📑

This project is in its secomd iteration. We might have NodeJS as backend. In future, might do clustering of students on the basis of the course taken.
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 ✨

Expand All @@ -22,13 +22,13 @@ Please go through the Wiki. The success of our vision to bring knowledge to ever
- [How to create a PR?](https://github.com/OpenLake/Knowledge-Sharing-Platform/wiki/How-to-create-a-PR%3F)
- [PR Format Guidelines](https://github.com/OpenLake/Knowledge-Sharing-Platform/wiki/PR-Format-Guidelines)

## Set-up the project 💻
## Set up the project 💻

### Environment Variables

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

- For database, you can use the postgres database of Supabase. And the **connection string** can be found in the project settings of database, as shown in the picture below:
- 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](./assets/supabase_db_uri.png)

<br>
Expand All @@ -40,7 +40,7 @@ Make a `.env` with the same fields in `.env.example`.
<br>

- `TYPE, PROJECT_ID, PRIVATE_KEY_ID, PRIVATE_KEY='{"privateKey":""}', CLIENT_EMAIL, AUTH_URI, TOKEN_URI`
These variables can be found in `Service Accounts` section of Project Settings of the app by clicking on **Generate new private key**.
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](./assets//firebase_admin_settings.png)

### Install the dependencies
Expand Down

0 comments on commit d2067c2

Please sign in to comment.