Skip to content

Vita-App/Admin

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


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

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}/Admin.git

    example : git clone https://github.com/Vita-App/Admin.git

  3. Install NPM packages

    npm run install
  4. Start the react server

    npm run start

Setting up DATABASE

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
  • Deploy on Netlify
  • Add github workflows

Future Goals

  • Add User Page
  • Integrate with Backend API
  • Making Initial Landing Page

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-admin.netlify.app/


Acknowledgements

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Rishabh Malhotra

📖 🚇

Lalit

💻 🎨

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