COLLAB IDE

Backend for in-browser collaborative code editor.

About • Local Development • Features • Language Support • Documentation • Suggestions

---

About

A Django based API backend for COLAB-IDE.

Local Development

Developing or running locally steps:

Step 1: Clone the repo and get inside the repo

$ git clone https://github.com/sinmrinal/collab-ide-backend.git && cd collab-ide-backend

Step 2: [OPTIONAL] Create virtual enviroment

1. Install virtualenv

   $ pip install virtualenv

2. Create Enviroment

   $ virtualenv env

3. Activate Enviroment

   $ source env/bin/activate

Step 3: Install dependencies

Dependencies are in requirements.txt file. Just run-

# Install dependencies
$ pip install -r requirements.txt

Step 4: Usage

Now you can run the application by :

# Set TOKEN
$ export TOKEN="add your token here without quotes."

# Run the project
$ python3 manage.py runserver

# Projects runs on http://localhost:8000

OR Using Docker

Step 1: Clone the repo and get inside the repo

$ git clone https://github.com/sinmrinal/collab-ide-backend.git && cd collab-ide-backend

Step 2: Build the image

$ docker build -t collab-backend-image .

Step 3: Run container/app

$ docker run -d --name collab-backend -p 8000:8080 collab-backend-image

Features

Feature	Status	Stability
Boilerplate Depricated	Done	Stable
Compile Code	Done	Stable
Collaborate	Done	Exprimental
Chat WebSocket	TODO	-
CLI	WIP	-
Save Project on Server	TODO	-

Language Support

Language	Support
C	✔️
C++	✔️
Java	✔️
python	✔️
Go	✔️
Dart Depricated	✔️
Rust	✔️

API Documentation

Request	Protocal	Type	Payload	Response
Boilerplate Code Depricated	HTTP	GET	-	boilerplate
Compile Code	HTTP	POST	{language, code, input}	{language, output}
Create Room	HTTP	POST	{roomName, adminName, token}	{roomID, roomName, createdBy, createdOn}
Join Room	HTTP	POST	{roomID, userName, token}	{roomID, roomName, createdBy, createdOn, joinedBy}

Suggestion

Reach out to me at one of the following places:

• LinkedIn: Mrinal Singh
• E-Mail: mrinal_singh@outlook.com