https://github.com/zingzy/study-sync
Study Session is a collaborative web application that allows users to upload resources, chat in real-time, and manage study sessions seamlessly.
https://github.com/zingzy/study-sync
flask live-chat python websocket
Last synced: about 1 month ago
JSON representation
Study Session is a collaborative web application that allows users to upload resources, chat in real-time, and manage study sessions seamlessly.
- Host: GitHub
- URL: https://github.com/zingzy/study-sync
- Owner: Zingzy
- Created: 2024-08-17T15:55:13.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-19T06:13:23.000Z (almost 2 years ago)
- Last Synced: 2025-03-02T05:44:45.045Z (over 1 year ago)
- Topics: flask, live-chat, python, websocket
- Language: HTML
- Homepage:
- Size: 311 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A collaborative web app for uploading resources, real-time chat, and seamless study session management
🔥 Features
👀 Demo
⚒️ Installation
🚀 Usage
## ⚡ Introduction
StudySync is a web application designed to facilitate collaborative study sessions. Users can upload resources, chat with each other, and share their progress in real-time. The application ensures a seamless and interactive learning experience.
## 👀 Demo
https://github.com/user-attachments/assets/deb621e2-1941-4560-9b9b-2af75175941f
## 🔥 Features
- **Resource Upload**: Upload various types of resources including images, documents, and more using the i.spoo.me API
- **Real-time Chat**: Communicate with other participants in real-time.
- **Session Management**: Create, join, and leave study sessions easily.
- **Interactive Dashboard**: Easily view and manage all of your study sessions.
## ⚒️ Installation
### Prerequisites
- Python 3.x
- Flask
- MongoDB
### Steps
1. Clone the repository:
```bash
git clone https://github.com/zingzy/study-sync.git
cd study-sync
```
2. Install backend dependencies:
```bash
pip install -r requirements.txt
```
3. Set up the environment variables:
```bash
mv .env.example .env
```
4. Update the `.env` file with your `MongoDB URI` and other `smtp server` configurations.
5. Run the application:
```bash
python main.py
```
## 🚀 Usage
1. Open your browser and navigate to `http://localhost:5000`.
2. Create a new study session or join an existing one.
3. Upload resources and start chatting with other participants.
## 🤝 Contributing
We welcome contributions! Please follow these steps:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push to the branch (`git push origin feature-branch`).
6. Open a pull request.
## 📄 License
This project is licensed under the Apache 2.0 License. See the LICENSE file for details.
## 📧 Contact
For any questions or feedback, please contact us at [admin@spoo.me](mailto:admin@spoo.me).
---
© zingzy . 2024
All Rights Reserved
