StudyBuddy - Connect and Collaborate Worldwide for Group Learning.!

StudyBuddy is an interactive platform designed to connect individuals from around the world to collaborate and learn together.
Whether you're eager to explore Python, delve into algebra, or explore any other subject, StudyBuddy helps you find like-minded learners or experts to join in a productive study session.
Users can browse the listed rooms, participate and help to the subject by leaving comments based on their knowledge.

Technology Stack

The StudyBuddy website is built using the following technology stack

• Python
• Django
• HTML
• CSS
• JavaScript
• PostgreSQL
• Cloudinary

Getting Started

To set up and run this project, you need to have the following tools installed

Prerequisites

• Python
• PostgreSQL
• Cloudinary

Installation

1. Clone or download the repository to your local machine

   git clone https://github.com/Nitzantomer1998/StudyBuddy.git

2. Change into the project directory

   cd StudyBuddy

3. Install all the required dependencies

   pip install -r requirements.txt

4. Set up your PostgreSQL and Cloudinary databases and update the database settings in the project

   python manage.py makemigrations base

   python manage.py makemigrations

   python manage.py migrate

5. Create a superuser for administrative access

   python manage.py createsuperuser

6. Run the development server

   python manage.py runserver

7. Access the website in your browser at the URL

   http://localhost:8000

Features

• User Authentication and Authorization
• Interactive users Activities
• Detailed Room information
• Room Management
• Profile Management
• User-Friendly Study Room Search
• Image Management with Cloudinary
• Security and Data Sanitization
• Error Handling and Flash Messages
• Create and Join Study Rooms for Any Topic
• Ask Questions, Share Knowledge, and Collaborate
• Responsive Design for Any Screen Size

Limitations

• Limited storage capacity
• Limited performances

Future Improvements

• Real-time Chat within Study Rooms
• Integration with Additional Learning Resources and Tools
• Optimized Hosting for a Superior Quality of Service

Support

For any questions or issues, please open an issue on the GitHub repository or contact the project maintainers directly.

Contributing

We welcome contributions from the community. If you are interested in contributing to this project, please follow these guidelines

• Fork the repository and create a new branch for your changes.
• Make your changes and ensure that the code is well-documented and properly tested.
• Open a pull request and provide a clear and detailed explanation of your changes and the reasoning behind them.
• Be prepared to answer questions and address any issues or feedback on your pull request.

StudyBuddy "Mobile" Preview

Home Page

Serve as the mobile version landing page.
Present you the existed study room that ready for exploration on the platform.

Room Creation Page

Serve as the mobile version room creation page.
Present you with a study room creation form.

Room View Page

Serve as the mobile version room view page.
Present you with a study room information and conversation.

Edit Room Page

Serve as the mobile version room edit page.
Present you with your study room information filled in a form which you can edit.

Delete Room Page

Serve as the mobile version room delete page.
Present you with delete confirmation message.

Topics View Page

Serve as the mobile version topics view page.
Present you with all the existing study room topics.

Activities View Page

Serve as the mobile version activities view page.
Present you with the 5 most recent activities on the platform.

Profile Center Page

Serve as the mobile version profile center page.
Present you with your information and related activities such as rooms and more.

Edit Profile Page

Serve as the mobile version profile edit page.
Present you with your information filled in a form which allow you to edit it.

Sign In Page

Serve as the mobile version sign in page.
Present you with a login form.

Sign Up Page

Serve as the mobile version sign un page.
Present you with a register form.

StudyBuddy "PC" Preview

Home Page

Serve as the PC version landing page.
Present you the existed study room that ready for exploration on the platform.

Room Creation Page

Serve as the PC version room creation page.
Present you with a study room creation form.

Room View Page

Serve as the PC version room view page.
Present you with a study room information and conversation.

Edit Room Page

Serve as the PC version room edit page.
Present you with your study room information filled in a form which you can edit.

Delete Room Page

Serve as the PC version room delete page.
Present you with delete confirmation message.

Topics View Page

Serve as the PC version topics view page.
Present you with all the existing study room topics.

Activities View Page

Serve as the PC version activities view page.
Present you with the 5 most recent activities on the platform.

Profile Center Page

Serve as the PC version profile center page.
Present you with your information and related activities such as rooms and more.

Edit Profile Page

Serve as the PC version profile edit page.
Present you with your information filled in a form which allow you to edit it.

Sign In Page

Serve as the PC version sign in page.
Present you with a login form.

Sign Up Page

Serve as the PC version sign un page.
Present you with a register form.