Skip to content

Ph4ntomByte/Study_Together

Repository files navigation

Study Together


A collaborative platform for students to organize and join study sessions.


🚀 Features

  • 📝 Study Plan Creation: Schedule sessions with location, time, and subject details.
  • 🔒 Privacy Controls: Public listings or share via private invitation links.
  • 🤝 Collaboration: Browse, join, or create study groups.
  • 💬 Group Chat: Real-time chat to coordinate within your group.
  • 📍 Meeting Management: Propose and vote on new meeting locations or times.
  • 📊 Progress Tracking: Mark topics complete and view overall group progress.

🎨 Screenshot Gallery

Explore the platform's interface:

Dashboard Screenshot Subject Screenshot

🤝 Get Involved

We welcome feedback and contributions! Whether you're reporting a bug or requesting a feature:


📂 Project Structure

study_together/
├── app/                   # Flask backend application
│   ├── app.py             # Flask app factory and routes
│   └── main.py            # Entry point for production run
├── instance/              # Instance-specific configurations
├── migrations/            # Flask-Migrate scripts
├── pics/                  # Logo and image assets
├── Dockerfile             # Build instructions for Docker image
├── docker-compose.yml     # Compose file to launch services
├── requirements.txt       # Python dependencies
├── pyproject.toml         # Packaging metadata
├── package.json           # Placeholder for JS deps
├── LICENSE                # MIT License
└── README.md              # This file

🐳 Docker Deployment

  1. In the project root, build and run containers:
docker compose up -d --build

Setup

  1. Clone Repo
    git clone https://github.com/Ph4ntomByte/Study_Together.git
    cd Study_Together
  2. Virtualenv
    python3 -m venv venv
    source venv/bin/activate   # Linux/macOS
  3. Install Requirements
    pip install --upgrade pip setuptools wheel
    pip install -r requirements.txt
  4. DB Migrations
    flask db upgrade
  5. Run Flask
    flask run --host=0.0.0.0 --port=5000
  6. Browse: http://localhost:5000

📄 License

This project is licensed under the GNU License. See the LICENSE file for details.


📞 Contact

Feel free to reach out at support@studentlifeishell.me for any questions or feedback.

About

Web-site to plan time to study with co-students

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors