Skip to content

kihuni/CollabSphere

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CollabSphere 🌐

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

✨ Features

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

📋 Requirements

  • Python 3.8+
  • Django 3.2+
  • Redis
  • PostgreSQL
  • Additional dependencies listed in requirements.txt

🛠️ Development

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

🤝 Contributing

  1. Fork the repository

  2. Create your feature branch (git checkout -b feature/AmazingFeature)

  3. Commit your changes (git commit -m 'Add some AmazingFeature')

  4. Push to the branch (git push origin feature/AmazingFeature)

  5. Open a Pull Request

About

Smart Collaboration Platform

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published