https://github.com/rakibhossain72/codecolabe
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.
https://github.com/rakibhossain72/codecolabe
code-share-platform django realtime-collobarative-editor
Last synced: 12 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/rakibhossain72/codecolabe
- Owner: rakibhossain72
- License: mit
- Created: 2024-08-30T04:39:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-30T13:11:09.000Z (over 1 year ago)
- Last Synced: 2025-02-10T06:32:36.987Z (about 1 year ago)
- Topics: code-share-platform, django, realtime-collobarative-editor
- Language: Python
- Homepage: https://codecolabe.onrender.com
- Size: 18.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
CodeColabe README
CodeColabe
==========
**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.
Features
--------
* **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.
Getting Started
---------------
### Prerequisites
Before you begin, ensure you have the following installed:
* Python 3.8+
* Django 4.x
* Django Channels 4.x
* Uvicorn
### Installation
1. **Clone the repository**:
git clone https://github.com/yourusername/CodeColabe.git
cd CodeColabe
2. **Create a virtual environment and activate it**:
python -m venv env
source env/bin/activate # On Windows use `env\Scripts\activate`
3. **Install the dependencies**:
pip install -r requirements.txt
4. **Apply migrations**:
python manage.py migrate
### Running the Server
To start the CodeColabe server, use Uvicorn:
uvicorn code_colabe.asgi:application --host 0.0.0.0 --port 8000
Navigate to `http://localhost:8000//` to start coding live in your workspace.
### Usage
* 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.
Project Structure
-----------------
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
Contributing
------------
Contributions are welcome! Please fork the repository and submit a pull request to contribute to CodeColabe.
License
-------
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Acknowledgments
---------------
* [Django](https://www.djangoproject.com/) - The web framework used
* [Django Channels](https://channels.readthedocs.io/en/stable/) - For WebSocket support
* [CodeMirror](https://codemirror.net/) - The code editor integrated into the platform