README: English | 中文

Coding WebIDE(https://ide.coding.net) is a cloud-based IDE developed by Coding Team.You can create your own workspace and develop projects here.WebIDE works fine with Git. You can use Coding、GitHub、BitBucket、GitLab as your Git repository. Workspaces are powered by Docker Ubuntu containers.The development environment can be saved and shared to your team member.

Live Demo

Please submit issues to corresponding projects, that'll help us make issues tracking easier so that we can provide timely help to you. Submit frontend issues at WebIDE-Frontend and backend issues at WebIDE-Backend.

1. Built-In Terminal
2. Syntax Highlighting
3. Language Tools
4. Themes
5. Split View
6. VIM／Emacs Mode
7. Previews

This is the entry point to setup and run the WebIDE Community Edition project. It includes other 3 repos as git submodules.

• WebIDE-Frontend contains frontend code.
• WebIDE-Frontend-Webjars packs frontend to webjar.
• WebIDE-Backend contains backend code.

WebIDE Frontend require node v6.x as build environment (this will save you from alot of weird errors). We recommend yarn for package management, webpack and babel is used for building.

Frontend Webjars & WebIDE Backend use maven3 and java8.

The project requires at minimum 512MB memory to run. Please ensure you have corresponding tools installed in your environment before build and run the project.

Clone from coding.net:

git clone [email protected]:coding/WebIDE.git

Clone from github.com:

git clone [email protected]:Coding/WebIDE.git

Init and pull submodules:

git submodule init
git submodule update

This will also clone the other 3 repos via git submodule mechanism.

We provide a shell script ide.sh to ease the process for you.

./ide.sh build   # transpile and pack the frontend to webjars
./ide.sh run     # start the backend server

Server runs on port 8080 by default, visit localhost:8080 to check it out.

backend/src/main/resources/application.properties contains configurations of user, project, database, etc., you can change these parameters to meet your need:

• SPACE_HOME: path to your workspace directory, default to ~/.coding-ide/workspace
• server.port: backend server port
• USERNAME: username, used by git as its user.name config when commit, defaults to "coding"
• EMAIL: email, used by git as its user.email config when commit, defaults to "[email protected]"
• AVATAR: user's avatar
• CODING_IDE_HOME: path to store WebIDE application's data, default to ~/.coding-ide

If changed, restart the application to let your configurations take effect. Note that changes on USERNAME, EMAIL WILL NOT apply to workspaces that are already created.

docker run -p 8080:8080 -v coding-ide-home:/root/.coding-ide webide/webide

To learn more about docker commands，please refer to wiki English 中文