Skip to content

Latest commit

 

History

History
336 lines (273 loc) · 18.2 KB

README.md

File metadata and controls

336 lines (273 loc) · 18.2 KB

COLLABSPHERE

license last-commit repo-top-language repo-language-count

Developed with the software and tools below.

HTML5 Python


🔗 Quick Links


📍 Overview

Real-Time Chat Application using Django


📦 Features

  1. Rooms or Group Chat: Join various chat rooms for diverse conversations.
  2. User Authentication: Securely log in to access personalized features.
  3. Security: Prioritize the safety of your interactions and data.
  4. ChatBot: Quick assistance with an integrated chatbot.
  5. Dark/Light Mode: Toggle between modes for a personalized experience.
  6. Responsiveness: Seamlessly access the chat across different devices.
  7. Interactive GUI: Engaging graphical user interface.
  8. Contact Us: Easily reach out for queries or assistance.
  9. Description of Room: Insights into each chat room's theme and purpose.

📂 Repository Structure

└── CollabSphere/
    ├── CollabSphere
    │   ├── README.md
    │   ├── core
    │   │   ├── __init__.py
    │   │   ├── __pycache__
    │   │   │   ├── __init__.cpython-311.pyc
    │   │   │   ├── __init__.cpython-39.pyc
    │   │   │   ├── admin.cpython-311.pyc
    │   │   │   ├── admin.cpython-39.pyc
    │   │   │   ├── apps.cpython-311.pyc
    │   │   │   ├── apps.cpython-39.pyc
    │   │   │   ├── forms.cpython-311.pyc
    │   │   │   ├── forms.cpython-39.pyc
    │   │   │   ├── models.cpython-311.pyc
    │   │   │   ├── models.cpython-39.pyc
    │   │   │   ├── urls.cpython-311.pyc
    │   │   │   ├── urls.cpython-39.pyc
    │   │   │   ├── views.cpython-311.pyc
    │   │   │   └── views.cpython-39.pyc
    │   │   ├── admin.py
    │   │   ├── apps.py
    │   │   ├── forms.py
    │   │   ├── migrations
    │   │   │   ├── __init__.py
    │   │   │   └── __pycache__
    │   │   │       ├── __init__.cpython-311.pyc
    │   │   │       └── __init__.cpython-39.pyc
    │   │   ├── models.py
    │   │   ├── templates
    │   │   │   └── core
    │   │   │       ├── base.html
    │   │   │       ├── frontpage.html
    │   │   │       ├── login.html
    │   │   │       └── signup.html
    │   │   ├── tests.py
    │   │   ├── urls.py
    │   │   └── views.py
    │   ├── db.sqlite3
    │   ├── djangochat
    │   │   ├── __init__.py
    │   │   ├── __pycache__
    │   │   │   ├── __init__.cpython-311.pyc
    │   │   │   ├── __init__.cpython-39.pyc
    │   │   │   ├── asgi.cpython-311.pyc
    │   │   │   ├── asgi.cpython-39.pyc
    │   │   │   ├── settings.cpython-311.pyc
    │   │   │   ├── settings.cpython-39.pyc
    │   │   │   ├── urls.cpython-311.pyc
    │   │   │   └── urls.cpython-39.pyc
    │   │   ├── asgi.py
    │   │   ├── settings.py
    │   │   ├── urls.py
    │   │   └── wsgi.py
    │   ├── manage.py
    │   └── room
    │       ├── __init__.py
    │       ├── __pycache__
    │       │   ├── __init__.cpython-311.pyc
    │       │   ├── __init__.cpython-39.pyc
    │       │   ├── admin.cpython-311.pyc
    │       │   ├── admin.cpython-39.pyc
    │       │   ├── apps.cpython-311.pyc
    │       │   ├── apps.cpython-39.pyc
    │       │   ├── consumers.cpython-311.pyc
    │       │   ├── consumers.cpython-39.pyc
    │       │   ├── models.cpython-311.pyc
    │       │   ├── models.cpython-39.pyc
    │       │   ├── routing.cpython-311.pyc
    │       │   ├── routing.cpython-39.pyc
    │       │   ├── urls.cpython-311.pyc
    │       │   ├── urls.cpython-39.pyc
    │       │   ├── views.cpython-311.pyc
    │       │   └── views.cpython-39.pyc
    │       ├── admin.py
    │       ├── apps.py
    │       ├── consumers.py
    │       ├── migrations
    │       │   ├── 0001_initial.py
    │       │   ├── 0002_message.py
    │       │   ├── 0003_room_description_room_participants.py
    │       │   ├── 0004_alter_room_description.py
    │       │   ├── 0005_remove_room_description_remove_room_participants.py
    │       │   ├── __init__.py
    │       │   └── __pycache__
    │       │       ├── 0001_initial.cpython-311.pyc
    │       │       ├── 0001_initial.cpython-39.pyc
    │       │       ├── 0002_message.cpython-311.pyc
    │       │       ├── 0002_message.cpython-39.pyc
    │       │       ├── 0003_room_description_room_participants.cpython-311.pyc
    │       │       ├── 0004_alter_room_description.cpython-311.pyc
    │       │       ├── 0005_remove_room_description_remove_room_participants.cpython-311.pyc
    │       │       ├── __init__.cpython-311.pyc
    │       │       └── __init__.cpython-39.pyc
    │       ├── models.py
    │       ├── routing.py
    │       ├── templates
    │       │   └── room
    │       │       ├── room.html
    │       │       └── rooms.html
    │       ├── tests.py
    │       ├── urls.py
    │       └── views.py
    └── README.md

🧩 Modules

CollabSphere
File Summary
manage.py HTTP error 401 for prompt CollabSphere/manage.py
CollabSphere.room
File Summary
admin.py HTTP error 401 for prompt CollabSphere/room/admin.py
apps.py HTTP error 401 for prompt CollabSphere/room/apps.py
tests.py HTTP error 401 for prompt CollabSphere/room/tests.py
views.py HTTP error 401 for prompt CollabSphere/room/views.py
consumers.py HTTP error 401 for prompt CollabSphere/room/consumers.py
routing.py HTTP error 401 for prompt CollabSphere/room/routing.py
urls.py HTTP error 401 for prompt CollabSphere/room/urls.py
models.py HTTP error 401 for prompt CollabSphere/room/models.py
CollabSphere.room.templates.room
File Summary
room.html HTTP error 401 for prompt CollabSphere/room/templates/room/room.html
rooms.html HTTP error 401 for prompt CollabSphere/room/templates/room/rooms.html
CollabSphere.room.migrations
File Summary
0003_room_description_room_participants.py HTTP error 401 for prompt CollabSphere/room/migrations/0003_room_description_room_participants.py
0001_initial.py HTTP error 401 for prompt CollabSphere/room/migrations/0001_initial.py
0002_message.py HTTP error 401 for prompt CollabSphere/room/migrations/0002_message.py
0004_alter_room_description.py HTTP error 401 for prompt CollabSphere/room/migrations/0004_alter_room_description.py
0005_remove_room_description_remove_room_participants.py HTTP error 401 for prompt CollabSphere/room/migrations/0005_remove_room_description_remove_room_participants.py
CollabSphere.core
File Summary
admin.py HTTP error 401 for prompt CollabSphere/core/admin.py
apps.py HTTP error 401 for prompt CollabSphere/core/apps.py
tests.py HTTP error 401 for prompt CollabSphere/core/tests.py
views.py HTTP error 401 for prompt CollabSphere/core/views.py
urls.py HTTP error 401 for prompt CollabSphere/core/urls.py
forms.py HTTP error 401 for prompt CollabSphere/core/forms.py
models.py HTTP error 401 for prompt CollabSphere/core/models.py
CollabSphere.core.templates.core
File Summary
login.html HTTP error 401 for prompt CollabSphere/core/templates/core/login.html
frontpage.html HTTP error 401 for prompt CollabSphere/core/templates/core/frontpage.html
base.html HTTP error 401 for prompt CollabSphere/core/templates/core/base.html
signup.html HTTP error 401 for prompt CollabSphere/core/templates/core/signup.html
CollabSphere.djangochat
File Summary
asgi.py HTTP error 401 for prompt CollabSphere/djangochat/asgi.py
wsgi.py HTTP error 401 for prompt CollabSphere/djangochat/wsgi.py
urls.py HTTP error 401 for prompt CollabSphere/djangochat/urls.py
settings.py HTTP error 401 for prompt CollabSphere/djangochat/settings.py

🚀 Getting Started

Requirements

Ensure you have the following dependencies installed on your system:

  • Python: version x.y.z

⚙️ Installation

  1. Clone the CollabSphere repository:
git clone https://github.com/Craniace/CollabSphere
  1. Change to the project directory:
cd CollabSphere
  1. Install the dependencies:
pip install -r requirements.txt

🤖 Running CollabSphere

Use the following command to run CollabSphere:

python main.py

🧪 Tests

To execute tests, run:

pytest

🤝 Contributing

Contributions are welcome! Here are several ways you can contribute:

Contributing Guidelines
  1. Fork the Repository: Start by forking the project repository to your GitHub account.
  2. Clone Locally: Clone the forked repository to your local machine using a Git client.
    git clone https://github.com/Craniace/CollabSphere
  3. Create a New Branch: Always work on a new branch, giving it a descriptive name.
    git checkout -b new-feature-x
  4. Make Your Changes: Develop and test your changes locally.
  5. Commit Your Changes: Commit with a clear message describing your updates.
    git commit -m 'Implemented new feature x.'
  6. Push to GitHub: Push the changes to your forked repository.
    git push origin new-feature-x
  7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

Once your PR is reviewed and approved, it will be merged into the main branch.


Return