Skip to content

Latest commit

 

History

History
248 lines (169 loc) · 8 KB

README.md

File metadata and controls

248 lines (169 loc) · 8 KB
Raw

Logo

VITdost

A Fully-Featured Advanced Educational Platform
Explore the docs »

View Demo · Report Bug · Request Feature

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

About The Project

land

VITdost was initially launched in July 2021. VITdost 2.0 is an upgraded version, bigger and better.

VITdost is an advanced platform to bridge all the technological gaps. Designed specifically for VITians, this platform includes features like :

  1. A Collaborative IDE - Due to the COVID-19 pandemic, all of us are at different parts of the world. Peer - Coding is not the same as before. But wait, this IDE is different, here you can chat and video call, form a group, and code collaboratively in real-time. Whatever you code is visible to your entire team simultaneously in real-time. It simple to use - login, create a new workspace and add collaborators or use a saved one, and start coding.

  2. Interviews - Online Placements ? Have to give an interview in front of a bot ? Sounds crazy, but thats what a lot of companies are adopting in their hybrid recruitment procedures. This platform provides a mock timed - online interview practice with industry standard questions. Choose a domain (technical / HR), take 1 min to prepare for the question, and give your best in the 3 minutes of your answering time. Once the interview is completed, your video is uploaded to the feed, where other users can give feedback and commennt on it.

  3. Library - A library made for VITians, by the VITians. Upload your study materials, books, past - year papers.

  4. GPA Calculator - This feature tells you what your semester GPA would be on the combination of grades you put with the number of credits. So set your goal and the start and work for it.

(back to top)

Built With

This project was built with the following frameworks and technologies:

(back to top)

Getting Started

Follow the steps given below to run the project locally on your system.

Prerequisites

  • npm 
    npm install npm@latest -g
npm install nodemon@latest -g

Installation

Once all the prerequisites are met, the required API Keys must be generated and dependencies must be installed.

  1. Get Amazon S3 Client Credentials at https://aws.amazon.com/

  2. Create a bucket in the AWS S3 Storage console for library and interview uploads.

  3. Create a free MongoDB Atlas cluster at https://www.mongodb.com/atlas

  4. Get a free Hackerearth API v4 key at https://www.hackerearth.com/docs/wiki/developers/v4/

  5. Generate a mock email ID through which emails can be sent to users of the website.

  6. Create a Twilio SendGrid API key from https://www.twilio.com/sendgrid/email-api. This is required, as to add collaborators to a workspace, they are invited using email.

  7. Clone the repo

    git clone https://github.com/rushabhkela/VITdost.git

  8. Install NPM packages

    npm install

  9. Create the .env file

    cp .env.example .env

  10. In the .env file, enter your credentials generated in the above steps and add a suitable session-key.

  11. Good to go! Start the project locally using the following command, and go to http://localhost:3000

    npm start

(back to top)

Usage

Collaborative IDE

Collab Collab Collab

Interview Platform

interview interview

Library

library

GPA Calculator

gpa

(back to top)

Roadmap

  • Think of a unique idea!
  • Implement the project.
  • Add a README.md
  • Deploy the project
  • Expand the scope of the project, implement new ideas.
    • Add a user profile

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)

License

This project is licensed under the Apache 2.0 License. See LICENSE for more information.

(back to top)

Contact

Rushabh Kela - +91 9834473257 - kelarushabh@gmail.com

Project Link: https://github.com/rushabhkela/VITdost

(back to top)

Acknowledgments

(back to top)