CollabSphere is a Django-based real-time communication platform plugin designed to enable seamless collaboration through chat rooms, direct messaging, group conversations, and file-sharing capabilities. Built with scalability and extensibility, CollabSphere provides a robust foundation for adding real-time communication features to your Django applications.
📋 Table of Contents
- Features
- Requirements
- Installation
- Development
- Contributing
Authentication
- 🔐 Custom user profiles
- 👤 User status tracking
- 🕒 Last seen functionality
- 🔑 Social authentication support
Chat Features
- 💬 Public chat rooms
- 📱 Direct messaging
- 👥 Group chats
- 📝 Message editing and deletion
- 👀 Read receipts
- ⌨️ Typing indicators
File Sharing
- 📁 Secure file uploads
- 🖼️ Image previews
- 📄 Document sharing
- 🔍 File search capabilities
Notifications
- 🔔 Real-time notifications
- 📧 Email notifications
- ⚙️ Custom notification preferences
- Python 3.8+
- Django 3.2+
- Redis
- PostgreSQL
- Additional dependencies listed in requirements.txt
Clone the repository:
clone https://github.com/yourusername/collabsphere.git
Create virtual environment:
python -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
Install development dependencies:
pip install -r requirements-dev.txt
Run tests:
python manage.py test
-
Fork the repository
-
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