Skip to content

Sauvikn98/Vita

Β 
Β 

Repository files navigation

πŸ“£ Latest Announcements

πŸ†• 22-02-2022: We now have a discord server, I strongly encourage all of you to join the server. Join Server

πŸ†• 21-02-2022: Vita is participating in GirlScript Summer of Code 2022 πŸ₯³



Contributors Forks Stargazers Issues MIT License LinkedIn CI/CD Digital Ocean


Logo

Vita

SEACH SCHEDULE & MEET
Explore the project Β»

View Demo Β· Report Bug Β· Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgements

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-hld


VITA APP

product-screenshoti

Mentors Page Topics Page
product-screenshotii product-screenshotiii
Submit Form Scheduler Component
product-screenshotv product-screenshotiv


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

  1. Fork the repo(required), a star is also appretiated but optional :P

  2. Clone the forked repo

    git clone https://github.com/{your-github-username}/Vita.git

    example : git clone https://github.com/Rishabh-malhotraa/Vita.git

  3. Install NPM packages

    npm run install-modules
  4. 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.

  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

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

All Contributors

Stargazers over time

Stargazers over time

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Rishabh Malhotra

πŸš‡ πŸ”£ 🎨 πŸ’» πŸ“Ή πŸ‘€

Lalit

πŸ’» 🎨 πŸ‘€ ⚠️

Indraan S. Toor

πŸ’»

Mad1ad

πŸ’»

Rishav Chattopadhya

πŸ’»

Gurdeep Singh

πŸ’» 🚧

Hazem Essam

πŸ’» 🚧

muzamil

πŸ’»

Harshil Jani

πŸš‡

Daniel Siebert

πŸš‡

Ankur Raj

πŸ’»

This project follows the all-contributors specification. Contributions of any kind welcome!

About

Bringing life back to your college life.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 72.2%
  • Handlebars 26.6%
  • JavaScript 0.4%
  • HTML 0.3%
  • CSS 0.3%
  • Shell 0.1%
  • Other 0.1%