StudyBud
A Study-Together platform to help create a healthy environment of knowledge where people can discuss their topics of interest in various rooms publicly.
Table of Contents
Built With
Getting Started
Prerequisites
Install Python IDE from the official site.
Installation
Follow the following steps to install and setup the virtual environment.
- Clone the repo
git clone https://github.com/Samrat-14/studybud.git
- Once inside the cloned repo, setup project environment with virtualenv and pip.
pip install virtualenv virtualenv env
- Activate the virtual environment and install all the requirements.
env\scripts\activate pip install -r requirements.txt
- After the installments are over, you can get started with the project.
Features
- Use the app as a guest user to view the rooms.
- Login to experience better performance and features like messaging in the rooms.
- Create rooms to host and share bits of information on the topics of interest.
- Join rooms and participate into discussions.
- Discuss with your room-mates with messaging feature to join the conversation.
Contributing
I love contributions, so please feel free to fix bugs, improve things, provide documentation. 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!
- 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
License
Distributed under the MIT License. See LICENSE for more information.
View Demo
Live Demo: https://samrat-studybud.herokuapp.com