Eclipse Theia IDE

Main Theia Repository

Visit the Theia website for more documentation: Using the Theia IDE, Packaging Theia as a Desktop Product.

License

• Eclipse Public License 2.0
• 一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception

Trademark

"Theia" is a trademark of the Eclipse Foundation https://www.eclipse.org/theia

What is this?

The Eclipse IDE is a modern and open IDE for cloud and desktop. The Theia IDE is based on the Theia platform. The Theia IDE is available as a downloadable desktop application. You can also try the latest version of the Theia IDE online. The online test version is limited to 30 minutes per session and hosted via Theia.cloud. Finally, we provide an experimental Docker image for hosting the Theia IDE online.

The Eclipse Theia IDE also serves as a template for building desktop-based products based on the Eclipse Theia platform, as well as to showcase Eclipse Theia capabilities. It is made up of a subset of existing Eclipse Theia features and extensions. Documentation is available to help you customize and build your own Eclipse Theia-based product.

Theia IDE vs Theia Blueprint

The Theia IDE has been rebranded from its original name “Theia Blueprint”. To avoid any confusion, the repository and code artifacts will keep the name “Blueprint”. You can therefore assume the terms “Theia IDE” and “Theia Blueprint” to be synonymous.

Development

Requirements

Please check Theia's prerequisites, and keep node versions aligned between Theia IDE and that of the referenced Theia version.

Documentation

Documentation on how to package Theia as a Desktop Product may be found here

Repository Structure

• Root level configures mono-repo build with lerna
• applications groups the different app targets
  • browser contains a browser based version of Eclipse Theia IDE that may be packaged as a Docker image
  • electron contains the electron app to package, packaging configuration, and E2E tests for the electron target.
• theia-extensions groups the various custom theia extensions for the Eclipse Theia IDE
  • product contains a Theia extension contributing the product branding (about dialogue and welcome page).
  • updater contains a Theia extension contributing the update mechanism and corresponding UI elements (based on the electron updater).
  • launcher contains a Theia extension contributing, for AppImage applications, the option to create a script that allows to start the Eclipse Theia IDE from the command line by calling the 'theia' command.

Build

For development and casual testing of the Eclipse Theia IDE, one can build it in "dev" mode. This permits building the IDE on systems with less resources, like a Raspberry Pi 4B with 4GB of RAM.

# Build "dev" version of the app. Its quicker, uses less resources, 
# but the front end app is not "minified"
yarn && yarn build:dev && yarn download:plugins

Production applications:

# Build production version of the Eclipse Theia IDE app
yarn && yarn build && yarn download:plugins

Package the Applications

ATM we only produce packages for the Electron application.

yarn package:applications
# or
yarn electron package

The packaged application is located in applications/electron/dist.

Create a Preview Electron Electron Application (without packaging it)

yarn electron package:preview

The packaged application is located in applications/electron/dist.

Running E2E Tests on Electron

The E2E tests basic UI tests of the actual application. This is done based on the preview of the packaged application.

yarn electron package:preview
yarn electron test

Running Browser app

The browser app may be started with

yarn browser start

and connect to http://localhost:3000/

Troubleshooting

• "Don't expect that you can build app for all platforms on one platform."

Reporting Feature Requests and Bugs

The features in the Eclipse Theia IDE are based on Theia and the included extensions/plugins. For bugs in Theia please consider opening an issue in the Theia project on Github. The Eclipse Theia IDE only packages existing functionality into a product and installers for the product. If you believe there is a mistake in packaging, something needs to be added to the packaging or the installers do not work properly, please open an issue on Github to let us know.

Docker

The Docker image of the Theia IDE is currently in experimental state. It is built from the same sources and packages as the desktop version, but it is not part of the preview test. You can find a prebuilt Docker image of the IDE here.

You can also create the Docker image for the Eclipse Theia IDE based on the browser app with the following build command:

docker build -t theia-ide -f browser.Dockerfile .

You may then run this with

docker run -p=3000:3000 --rm theia-ide

and connect to http://localhost:3000/