CodeColabe README
CodeColabe is a live code-sharing platform built with Django and Django Channels. It allows users to collaboratively edit code in real-time, using a simple and intuitive interface powered by CodeMirror. No login or authentication is required, making it easy to jump right into coding.
- Real-time Collaboration: Multiple users can edit code simultaneously, with changes reflected instantly.
- CodeMirror Integration: Syntax highlighting and code editing with the powerful CodeMirror editor.
- No Authentication Required: Join or create workspaces without needing to log in.
Before you begin, ensure you have the following installed:
- Python 3.8+
- Django 4.x
- Django Channels 4.x
- Uvicorn
-
Clone the repository:
git clone https://github.com/yourusername/CodeColabe.git cd CodeColabe -
Create a virtual environment and activate it:
python -m venv env source env/bin/activate # On Windows use `env\Scripts\activate` -
Install the dependencies:
pip install -r requirements.txt -
Apply migrations:
python manage.py migrate
To start the CodeColabe server, use Uvicorn:
uvicorn code_colabe.asgi:application --host 0.0.0.0 --port 8000
Navigate to http://localhost:8000/<workspace_name>/ to start coding live in your workspace.
- Simply open a browser and navigate to
http://localhost:8000/your_workspace_name/to start a new workspace or join an existing one. - Any code changes made by you or others will be instantly reflected across all connected clients.
CodeColabe/
├── core/
│ ├── consumers.py
│ ├── routing.py
│ ├── urls.py
│ └── views.py
│
├── code_colabe/
│ ├── asgi.py
│ ├── settings.py
│ ├── urls.py
│ └── wsgi.py
├── templates
│ ├── index.html
│ └──editor.html
│
└── manage.py
Contributions are welcome! Please fork the repository and submit a pull request to contribute to CodeColabe.
This project is licensed under the MIT License. See the LICENSE file for details.
- Django - The web framework used
- Django Channels - For WebSocket support
- CodeMirror - The code editor integrated into the platform