zsalab/theia-blueprint

Cloud & Desktop IDE Platform

Eclipse Theia is an extensible platform to develop full-fledged multi-language Cloud & Desktop IDE-like products with state-of-the-art web technologies.

Main Theia Repository

Visit the Theia website for more documentation.

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?

Eclipse Theia Blueprint product is a template to showcase the capabilities of Theia as well as how to build desktop-based products based on the platform. Theia Blueprint assembles a selected subset of existing Theia features and extensions. We provide installers for Theia Blueprint to be downloaded (see below) as well as documentation on how to customize this template to build a product and installers for your own Theia-based product.

What is it not?

Eclipse Theia Blueprint product is not a production-ready product. Therefore, it is also not a replacement for Visual Studio Code or any other IDE.

Development

Repository structure

• Root level configures mono-repo build with lerna
• electron-app contains app to package, packaging configuration, and E2E tests.
• theia-blueprint-product contains a Theia extension contributing the product branding (about dialogue and welcome page).
• theia-blueprint-updater contains a Theia extension contributing the update mechanism and corresponding UI elements (based on the electron updater).

Build

yarn

Package the application

yarn package

The packaged application is located in electron-app/dist.

Create a preview application (without packaging it)

yarn package:preview

The packaged application is located in electron-app/dist.

Running E2E Tests

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

yarn package:preview
(cd electron-app && yarn test)

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 Blueprint product are based on Theia and the included extensions/plugins. For bugs in Theia please consider opening an issue in the Theia project on Github. Eclipse Theia Blueprint product 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.