Edunity

Creating a Platform where students preparing for competitive exams can connect with their Seniors to seek guidance for improving their grades on a one-one basis.

View Demo · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

Landing Page

---

Mentor Dashboard

---

Student Dashboard

---

Marketplace

---

Why are we building this?

Here's why:

• Filthy tution fee demanded by private coaching institutions
• No Individual guidance/attension is provided
• No financial independence amoung college students

Features:

• College students arent going to demand so much to teach
• Individual attension from seniors who have been in a similar suituation a very few years ago
• College students bought into a new era of side hustle and gain financial Independence

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/roshangeorge97/Edunity.git

2. Install NPM packages

   npm install

3. Run the project locally

   npm run dev

4. Activate Tailwind CSS on another terminal in the cloned directory

   npx tailwindcss -i ./src/App.css -o ./dist/output.css --watch

(back to top)

Roadmap

Frontend

• Requests Page
  • Fix UI of Requests page
• Add appropriate favicon

Backend

• Discuss Page
  • Websocket Integration on Discuss page by creating something similar to chat rooms
• Feed Page
  • Use Thirdparty REST APIs to display news on Feed Section
• Chat Page
  • Display only the selected Mentor's chat on chat page not all of them.
  • Simple Websocket Integration to chat amoung mentors and students
• My Classes Page
  • Display the recently connected mentors at My Classes Page
• Marketplace
  • Implement CRUD Operations with firebase on Marketplace
• Checkout Page
  • Interate with stripe

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Project Contributors

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Roshan George - @dev_roshangeorg - [email protected]

Project Link: https://github.com/roshangeorge97/Edunity

(back to top)