π£ Latest Announcements
Vita
SEACH SCHEDULE & MEET
Explore the project Β»
View Demo
Β·
Report Bug
Β·
Request Feature
Table of Contents
About The Project
- During the pandemic, we all were homebound; the campus culture of each college withered away. Watercooler conversation after class mentoring or Gyan sessions from seniors has become a tail of the past. So to bridge the gap of loss of engagement, I present to you, Vita.
- A SAAS product to connect college graduates, alumni, and faculty to revive the culture of mentorship and foster a more connected and ENGAGED(pardon the pun) community.
Design Doc and Video Demonstration
Vita Case Study : Case Study
Vite Application Flow : User Journey
Video Demonstration : Video Link
Demonstration
VITA APP
Mentors Page | Topics Page |
---|---|
![]() |
![]() |
Submit Form | Scheduler Component |
---|---|
![]() |
![]() |
Built With
Written in TypeScript
Getting Started
Follow the instructions to set up the project on your local machine.
Read the Vita Case Study and User Journey doc.
Prerequisites
Install NodeJS LTS
-
npm
npm install npm@latest -g
Installation
-
Fork the repo(required), a star is also appretiated but optional :P
-
Clone the forked repo
git clone https://github.com/{your-github-username}/Vita.git
example :
git clone https://github.com/Rishabh-malhotraa/Vita.git
-
Install NPM packages
npm run install-modules
-
Start the react and nodejs server concucrrently
npm run dev
Setting up DATABASE
Run the following command to setup the DB
curl -X GET http://localhost:5000/api/seed-data
The following command will create a Password for admin panel access
curl -X POST http://localhost:5000/api/admin/create --header 'Content-Type: application/json' \
--data-raw '{
"name": "Rishabh Malhtora",
"email": "rishabhmalhotraa01@gmail.com",
"password": "password"
}'
To setup the database with mockdata, follow this guide
Roadmap
See the open issues for a list of proposed features (and known issues).
Things To do
- Inital Landing Page
- Linking MongoDB Database with the backend
- Sprinkling global state with Recoil (highly recommend it as compared to redux if there are no complex state transactions happening)
- Vita Meet
- Linking Vita Meet with caucus
- Infinite Scrolling on Search for Topics
- Deploy on Netlify and Heroku
- Design Doc
- Add github workflows
Future Goals
- Add Google Oauth
- Add a login page and a way to add mentors from the Frontend (send form data to the backend, which after validation add user in mentors collection)
- Add an admin panel to monitor all meetings.
- If a mentor/mentee does not show up, report as a no-show, and restrict their account.
- Improve Filters & add more topics
- Add Full-text Search Functionality for finding mentors!
- Add bookings page for each signed-in user, which allows the mentor to accept, deject and reschedule his appointments
- Use Redis Adapter instead of Node Cache :3
- Write Unit Test
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Refer to this article if you have any difficulty in making a pull request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Rishabh malhotraa - @rish_bishhh - rishabhmalhotraa01@gmail.com
Join Discord Server : https://discord.gg/gf9EzqZBe7
Discord : rishabh.malhotra#4193
Project Link: https://vitaa-app.netlify.app/
Acknowledgements
Stargazers over time
β¨
Contributors Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!