Skip to content

tjeske/che-theia-generator

 
 

Repository files navigation

@eclipse-che/theia-generator

===================================

Installation guide

Theia Generator can be installed locally or globally

Here is how to install it globally:

using yarn:

$ yarn global add @eclipse-che/theia-generator

using npm:

$ npm install -g @eclipse-che/theia-generator

Then, a new command line tool is available : che:theia

Using the tool

Once the tool is installed, the following commands are available:

  • che:theia init
  • che:theia production

(help is also available with command che:theia --help)

che:theia init

This command needs to be launched inside a cloned directory of Eclipse Theia cloned directory

$ git clone https://github.com/theia-ide/theia
$ cd theia
$ che:theia init

once the init command has been launched:

  • inside theia/che folder, all extensions have been cloned and checkout to their correct branches (if specified)
  • all extensions have their package.json updated to the versions used by the current theia. (cloned)
  • in packages folder, there are symlinks for each extension coming from theia/che folders. All packages are prefixed by @che-
  • in examples folder, a new folder named àssemblyhas been generated and include theche-theia` assembly of Theia

In order to build the product, just run yarn at the root folder (where theia has been cloned)

Development life-cycle

it's easy to check changes. Running yarn watch in a module and then running yarn watch in examples/assembly folder and using yarn run start in examples/assembly

che:theia production

A production's ready assembly of che-theia can be obtained by running from the root folder of theia: che:theia production

It will generate in ${where theia has been cloned}/production folder a ready-to-use assembly of theia, without lot of files (like source maps, source code, etc)

It can be started with the command node ${where theia has been cloned}/production/src-gen/backend/main.js

Developer's guide

See Contributing

License

EPL-2.0

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.6%
  • Other 1.4%