DevSocHackathon - Study with Me

About

Study With Me is a platform for students to come together to learn, interact and collaborate.

Table of Contents

• Abstract 🧾
• Browser Support 🌐
• Installation 🐣
• Contribution Guidelines ✒
• How to use ? 📖
• Current Implementations 👨‍💻
• Future Implementations 💻
• Individual Contribution ☕

Abstract

This is the GitHub repo for Study With Me Website - an online collaborative study portal.

Browser Support

Edge	Firefox	Chrome	Safari	Opera
Edge	last 3 versions	last 3 versions	last 3 versions	last 3 versions

Installation

Follow these steps to install this project directory:

# clone the repo
$ git clone https://github.com/Aviral09/DevSocHackathon.git

# go into app's directory:
$ cd DevSocHackathon

Contribution Guidelines

1. Fork the repo on GitHub.
2. Clone the project to your own machine.
3. Commit changes to your own branch.
4. Push your work back up to your fork.
5. Submit a pull request. (Make sure you merge before you make a pull request!)

Pull Request Guidelines

1. The subject should be a short one line summary of the change you've made.
2. The extended description should include a deatiled description of the changes you've made and also a list of all the files you've made changes in.
3. One pull request should cater to only one change. *A change may include multiple file changes that are essential to solving the issue/change.

How to use?

1. On the homepage top right corner click on "login/signup" button and you will be redirected to login/signup page.
2. One has to login through BITS Mail using "Google Signin" button. The registration input boxes are not funtional as of now.
3. Once the status of google login button changes to Signed In, one has to click on "Go to preferences" button and you will be directed to Preferences page.
4. The preferences input boxes are not functional yet and will be implemented in the future.

Current Implementations

1. Frontend of the whole project is done using HTML and CSS.
2. Few improvements in frontend are made using inline Javascript.
3. Integrated Google Signin button has been implemented.

Future Implementations

1. Redirecting to next page after Google Signin is complete and implementing signInWithRedirect rather than signinWithPopup.
2. Backend with database to get the user input preference and matching up with study-partner with desired preferences.
3. Implementing API to get them connected to online meeting services like Google Meet.

Individual Contribution

Aviral Kumar Goel - Guidance
Rohit Kodam - Why To Use ?, Reviews, Styling of filters/preferences, Google Signin button
Naman Ajay Markhedkar - Login, Filter/Preferences
Shlok Sinha - Navbar, Homepage, Styling of filters/preferences
Varun Gopal - How To Use
Sejal Sarada - Footer, ReadMe

Social Media

Instagram: https://www.instagram.com/devsocbitsgoa

Devsoc's Website: https://devsoc.club/