forked from eclipse-che/che
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Tyler Jewell
authored
Jul 17, 2016
1 parent
09c7825
commit 2725154
Showing
1 changed file
with
21 additions
and
142 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,158 +1,37 @@ | ||
| # Eclipse Che | ||
| # Eclipse Che - Open Source | ||
| [](https://gitter.im/eclipse/che?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
| [](https://github.com/codenvy/che/blob/master/LICENSE) | ||
| <!--- | ||
| [](http://ci.codenvy-dev.com/jenkins/job/che-ci-master) | ||
| --> | ||
|
|
||
| https://www.eclipse.org/che/. Next-generation Eclipse IDE. Open source workspace server and cloud IDE. | ||
| https://www.eclipse.org/che/. Next-generation Eclipse platform. Open source workspace server and cloud IDE. Che defines workspaces that include their dependencies including embedded containerized runtimes, Web IDE, and project code. This makes workspaces distributed, collaborative, and portable to run anywhere on a desktop or a server ... [Read More](https://www.eclipse.org/che/features/) | ||
|
|
||
|  | ||
| <img src="https://www.eclipse.org/che/images/features/img-features-a-new-kind-of-workspace.png" height="192" width="288"/> <img src="https://www.eclipse.org/che/images/features/img-features-collaborative-workspace-server.png" height="192" width="288"/> <img src="https://www.eclipse.org/che/images/features/img-features-cloud-ide.png" height="192" width="288"/> <img src="https://www.eclipse.org/che/images/features/img-features-docker-powered.png" height="192" width="288"/> <img src="https://www.eclipse.org/che/images/features/img-features-workspace-agents.png" height="192" width="288"/> <img src="https://www.eclipse.org/che/images/features/img-features-RESTful.png" height="192" width="288"/> <img src="https://www.eclipse.org/che/images/features/img-features-ssh-workspaces.png" height="192" width="288"/> <img src="https://www.eclipse.org/che/images/features/img-features-multi-project-workspaces.png" height="192" width="288"/> <img src="https://www.eclipse.org/che/images/features/img-features-commands.png" height="192" width="288"/> <img src="https://www.eclipse.org/che/images/features/img-features-intellisense-java.png" height="192" width="288"/> <img src="https://www.eclipse.org/che/images/features/img-features-light-theme.png" height="192" width="288"/> <img src="https://www.eclipse.org/che/images/features/img-features-dogfooded.png" height="192" width="288"/> | ||
|  | ||
|
|
||
| ### Workspaces With Runtimes | ||
| Workspaces are composed of projects and runtimes. Create portable and moavable workspaces that run anywhere, anytime in the cloud or on your desktop ... [Read More](https://www.eclipse.org/che/features/#new-workspace) | ||
| ### Getting Started | ||
| You can run Che in the public cloud, a private cloud, or install it on any OS. Che has been tested on Ubuntu, Linux, MacOS and Windows. The [step by step guide](http://eclipse.org/che/getting-started/) will get you going. | ||
|
|
||
| ### Collaborative Workspace Server | ||
| Host Eclipse Che as a workspace server. Share tools, runtime and programming services across workspaces and teams. Control workspaces with REST APIs ... [Read More](https://www.eclipse.org/che/features/#collaborative) | ||
| The `che` repository is where we do development and there are many ways you can participate, for example: | ||
|
|
||
| ### Docker-Powered Environments | ||
| Workspace runtimes are Docker-powered. Use our all-in-one stacks, pull from any registry, or author your own. Snapshot and embed runtimes into ... [Read More](https://www.eclipse.org/che/features/#docker-powered) | ||
| - [Submit bugs and feature requests](http://github.com/eclipse/che/issues) and help us verify them | ||
| - Review [source code changes](http://github.com/eclipse/che/pulls) | ||
| - [Review the docs](https://eclipse-che.readme.io/docs/) and make improvements for anything from typos to new content | ||
|
|
||
| ### Cloud IDE | ||
| A no-installation browser IDE and IOE accessible from any local or remote device. Thin, fast, and beautiful - it's the IDE our own engineers wanted ... [Read More](https://www.eclipse.org/che/features/#cloud-ide) | ||
| ### Customizing | ||
| There are many ways to customize Che out-of-the-box including [stacks, templates, commands, IDE extensions, server-side extensions plugins, assemblies, RESTful APIs, and editors](https://github.com/eclipse/che/blob/master/CUSTOMIZING.md). | ||
|
|
||
| ### Getting Started | ||
| Che can be installed on any OS that supports Java 1.8 - desktop, server or cloud, and Maven 3.3.1. It has been tested on Ubuntu, Linux, MacOS and Windows. | ||
| ### Contributing | ||
| If you are interested in fixing issues and contributing directly to the code base, please see [How to Contribute](https://github.com/eclipse/che/wiki/How-To-Contribute). It covers: | ||
| - [Submitting bugs](https://github.com/eclipse/che/wiki/Submitting-Bugs-and-Suggestions) | ||
| - [Development workflow](https://github.com/eclipse/che/wiki/Development-Workflow) | ||
| - [Coding guidelines](https://github.com/eclipse/che/wiki/Coding-Guidelines) | ||
| - [Contributor license agreement](https://github.com/eclipse/che/wiki/Contributor-License-Agreement) | ||
|
|
||
| Follow the [step by step guide](http://eclipse.org/che/getting-started/) to install Che from our binaries. | ||
| ### Feedback | ||
| * **Support:** You can ask questions, report bugs, and request features using [GitHub issues](http://github.com/eclipse/che/issues). | ||
| * **Roadmap:** We maintain [the roadmap](https://github.com/eclipse/che/wiki/Roadmap) on the wiki. | ||
| * **Weekly Meetings:** Join us on [a hangout](https://github.com/eclipse/che/wiki/Weekly-Planning-Meetings). | ||
|
|
||
| ### License | ||
| Che is open sourced under the Eclipse Public License 1.0. | ||
|
|
||
| ### Dependencies | ||
| * Docker 1.8+ | ||
| * Maven 3.3.1+ | ||
| * Oracle Java 1.8 -- compilation with openjdk is not yet supported | ||
|
|
||
| ### Clone | ||
|
|
||
| ```sh | ||
| git clone https://github.com/eclipse/che.git | ||
| ``` | ||
| If master is unstable, checkout the latest tagged version. | ||
|
|
||
| ### Build and Run | ||
| ```sh | ||
| cd che/assembly | ||
| mvn clean install | ||
|
|
||
| # A new assembly is placed in: | ||
| cd che/assembly/assembly-main/target/eclipse-che-<version>/eclipse-che-<version> | ||
|
|
||
| # Executable files are: | ||
| bin/che.sh | ||
| bin/che.bat | ||
| ``` | ||
| Che will be available at ```localhost:8080```. | ||
|
|
||
| ### Build Submodules | ||
| Building `/assembly` pulls already-built libraries for `/core`, `/plugins`, and `/dashboard` from our Nexus repository. | ||
|
|
||
| To build the Che core: | ||
| ```sh | ||
| # Install maven-patch-plugin as an additional dependency. | ||
| cd che/core | ||
|
|
||
| # Windows: maven-patch-plugin does not work, so skip tests when building: | ||
| # See: https://maven.apache.org/plugins/maven-patch-plugin/faq.html#Why_doesnt_this_work_on_Windows | ||
| mvn -DskipTests=true -Dfindbugs.skip=true -Dskip-validate-sources clean install | ||
| ``` | ||
|
|
||
| To build Che plugins: | ||
| ```sh | ||
| cd che/plugins | ||
| mvn clean install | ||
| ``` | ||
|
|
||
| To build the Che dashboard: | ||
| ```sh | ||
| # You need NPM, Bower, and Gulp installed. | ||
| # See setup in /dashboard | ||
| cd che/dashboard | ||
| mvn clean install | ||
| ``` | ||
|
|
||
| ### Build Che Using Docker | ||
| If you want to avoid setting up the dependencies to compile Che core, plugins and the dashboard, we provide a Docker image that has all dependencies necessary to compile Che. You can have Che source code on your host and compile it within the container. | ||
|
|
||
| ```sh | ||
| # For Mac + Linux: | ||
| docker run -it --rm --name build-che | ||
| -v "$HOME/.m2:/home/user/.m2" | ||
| -v "$PWD":/home/user/che-build | ||
| -w /home/user/che-build | ||
| codenvy/che-dev | ||
| mvn -DskipTests=true | ||
| -Dfindbugs.skip=true | ||
| -Dgwt.compiler.localWorkers=2 -T 1C | ||
| -Dskip-validate-sources | ||
| clean install | ||
|
|
||
| # For Windows, replace $HOME with maven repo directory. | ||
| # For Windows, replace $PWD with Che source code directory. | ||
| ``` | ||
|
|
||
| ### Run Che as a Server | ||
| If you want to run Che as a server where non-localhost clients connect, there are additional flags that you may need to configure. Please see the [usage documentation](https://eclipse-che.readme.io/docs/usage). | ||
|
|
||
|
|
||
| ### Repositories | ||
| These repositories are for the core project hosted at `http://github.com/eclipse`. | ||
| ``` | ||
| /che | ||
| /che/assembly # Generates binary assemblies of Che | ||
| /che/assembly/assembly-main # Final packaging phase | ||
| /che/assembly/assembly-ide-war # Creates the IDE.war from plug-ins & core | ||
| /che/assembly/assembly-machine-war # Creates the agent WAR from plug-ins & core | ||
| /che/assembly/assembly-machine-server # Creates the agent server that goes into ws | ||
| /che/core # Libraries shared among server, agents, and plugins | ||
| /che/dashboard # AngularJS app for managing Che | ||
| /che/plugins # IDE & agent plug-ins | ||
| /che/wsmaster # Libraries used by the Che server | ||
| /che/wsagent # Libraries used by agents installed into workspaces | ||
| /che-lib # Forked dependencies that require mods | ||
| /che-lib/swagger | ||
| /che-lib/terminal | ||
| /che-lib/websocket | ||
| /che-lib/pty | ||
| /che-lib/che-tomcat8-slf4j-logback | ||
| # /che and /che-lib depend upon /che-dependencies | ||
| /che-dependencies # Maven dependencies used by che | ||
| /che-dev # Code style and license header | ||
| # /che-dependencies and /che-dev depend upon /che-parent | ||
| /che-parent # Maven plugins and profiles | ||
| ``` | ||
|
|
||
| ### Other Repositories | ||
| These are external repositories that provide additional tools for Eclipse Che. | ||
| ``` | ||
| http://github.com/codenvy/Dockerfiles # Defines the images referenced by stacks in Che | ||
| http://github.com/codenvy/che-installer # Creates the Windows and JAR installer packages | ||
| http://github.com/codenvy/che-tutorials # SDK examples and tutorials (needs updating) | ||
| http://github.com/che-samples # GitHub organization with sample repos used in Che | ||
| http://git.eclipse.org/c/www.eclipse.org/che.git # The content for eclipse.org/che Web site | ||
| http://github.com/codenvy/cli # Experimental CLI for managing Che workspaces on the CLI | ||
| ``` | ||
|
|
||
| ### Engage | ||
| * **Contribute:** We accept pull requests. Please see [how to contribute] (https://github.com/codenvy/che/blob/master/CONTRIBUTING.md). | ||
| * **Customize:** [Runtimes, stacks, commands, assemblies, extensions, plug-ins](https://github.com/eclipse/che/blob/master/CUSTOMIZING.md). | ||
| * **Support:** You can report bugs using GitHub issues. | ||
| * **Roadmap:** We maintain [the roadmap](https://github.com/eclipse/che/wiki/Roadmap) on the wiki. | ||
| * **Weekly Meetings:** Join us on [a hangout](https://github.com/eclipse/che/wiki/Roadmap-Meeting-Schedule). | ||
| * **Developers:** Plug-in developers can get API help at [che-dev@eclipse.org](email:che-dev@eclipse.org). | ||
| * **Website:** [eclipse.org/che](https://eclipse.org/che). |