https://github.com/westerbean/studywithme
A Django-based web application designed to create collaborative study rooms where users can join, create groups, and send messages in real-time.
https://github.com/westerbean/studywithme
django djangorestframework python3
Last synced: 4 months ago
JSON representation
A Django-based web application designed to create collaborative study rooms where users can join, create groups, and send messages in real-time.
- Host: GitHub
- URL: https://github.com/westerbean/studywithme
- Owner: westerbean
- Created: 2025-03-10T15:15:15.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-03-12T02:03:38.000Z (4 months ago)
- Last Synced: 2025-03-12T03:18:55.838Z (4 months ago)
- Topics: django, djangorestframework, python3
- Language: HTML
- Homepage:
- Size: 3.32 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**Study Room Web App**
A Django-based web application designed to create collaborative study rooms where users can join, create groups, and send messages in real-time.
**Features**
User Authentication: Secure sign-up and login using email and password.
Create & Join Rooms: Users can create rooms around various topics, or join existing rooms to collaborate.
Real-time Messaging: Each room has a messaging system for users to communicate.
User Profiles: Users can customize their profile with an avatar, bio, and personal information.
Search Functionality: Search rooms by topic or name, making it easier to find relevant study groups.
Activity Feed: See recent activity and messages across the platform.
Tech Stack
Backend: Django (Python)
Frontend: HTML, CSS, JavaScript
Database: SQLite (or your preferred database)
Authentication: Django's built-in user authentication system
Deployment: Can be deployed on platforms like Heroku, DigitalOcean, or similar.
Installation
**_Clone the repository_**:
git clone https://github.com/yourusername/study-room-app.git
cd study-room-app
**_Create a virtual environment and activate it_**:
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
**_Install the required dependencies_**:
pip install -r requirements.txt
**_Run migrations to set up the database_**:
python manage.py migrate
**_Create a superuser to access the Django admin panel_**:
python manage.py createsuperuser
**_Start the development server_**:
python manage.py runserver
The app will be running at http://127.0.0.1:8000/.
**Usage**
Create a new account or login using email and password.
Create a new room or join existing rooms to engage in study groups.
Send and receive messages in real-time with other participants in the room.
Screenshots
**Contributing**
Feel free to fork the repository, make improvements, or submit pull requests. Any contributions are welcome!