Coder Social home page Coder Social logo

assembly-che's Introduction

##Build and Run

Clone the Repository

git clone https://github.com/codenvy/assembly-che.git

Run the script, that clones all Codenvy repositories

To run the script you need to generate an access token in your github account: https://help.github.com/articles/creating-an-access-token-for-command-line-use/

Set github token environment variable

export GITHUB_TOKEN=[paste generated token]

Run the script

./clone_codenvy.sh

Build and Run Che

./build.sh
./sdk/assembly-sdk/target/tomcat-ide/bin/che.sh [ start | stop ]

Che will be available at localhost:8080

##Add Own Extensions

There are two ways to create own Che assembly with a custom extension: automated and manual. There's no difference in terms of what needs to be done - the script does what you can do by hand to better understand the process.

###Script-Based Approach

Build your extension, copy jar to /ext directory, run extInstall.sh script and start Che:

cd ~/sdk/assembly-sdk/target/tomcat-ide/ext
cp ~/your-extension-1.1.0-SNAPSHOT.jar .
cd ..
./extInstall.sh
cd ~/sdk
./che.sh start

Che will be recompiled and your custom jar will be included to the bundle.

###Creating Che Assembly Manually

####Add Plug-In Dependency

Build your extension:

mvn clean install

Then, add your plug-in as a dependency. When re-compiling Che, the plug-in jar will be picked from your local Maven repository and included in the Che bundle. Add the dependency to:

~/sdk/assembly-ide/pom.xml

as:

<dependency>
  <groupId>com.your.company</groupId>
  <artifactId>helloworld-extension</artifactId>
  <version>1.0.0-SNAPSHOT</version>
</dependency>

Note that the dependenies have to be sorted alphabetically. The dependencies without scope provided come first, and then scope provided second. The best way here is to sort pom.xml just after adding the dependency to make sure it is OK:

mvn sortpom:sort

####Define a Module

Navigate to sdk/assembly-ide/src/main/resources/com/codenvy/ide and open IDE.gwt.xml which species the GWT application and defines all modules. This defines all of the models for the application. When GWT boots, it injects the classes defined in the gwt.xml file from your extension class, HellowWorldExtension. You need to add an inheritance to the extension, provided that the project gwt module is located at /src/main/resources/com/codenvy/ide/ext/helloworld/HelloWorldExtension.gwt.xml:

cd ~/sdk/assembly-ide/src/main/resources/com/codenvy/ide

And add the following to IDE.gwt.xml:

<inherits name="com.codenvy.ide.ext.helloworld.HelloWorldExtension"/>

Name differes depending on name and location of gwt.xml of a custom extension.

Finally, rebuild Che:

mvn clean install

assembly-che's People

Contributors

skabashnyuk avatar sashabolshakov avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.