/cdt-cloud-blueprint

CDT.cloud Blueprint is a template for building custom web-based C/C++ tools. It is made up of existing open source components and can be easily downloaded and installed on all major operating system platforms.

Primary LanguageTypeScriptOtherNOASSERTION


CDT.cloud Blueprint is a template for building custom web-based C/C++ tools. It is made up of existing open source components and can be easily downloaded and installed on all major operating system platforms.

Visit the CDT.cloud website for more information.

License

What is this?

CDT.cloud Blueprint is a template for building custom web-based C/C++ tools. It is made up of existing open source components and can be easily downloaded and installed on all major operating system platforms.

What is it not?

CDT.cloud Blueprint is not a production-ready product. Therefore, it is also not meant to be a replacement for Visual Studio Code or any other IDE.

Development

CDT.cloud Blueprint is based on Eclipse Theia Blueprint.

Requirements

Please check Theia's prerequisites, and keep node versions aligned between CDT.cloud Blueprint 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
    • electron contains app to package, packaging configuration, and E2E tests for the Electron target.
  • theia-extensions groups the various custom theia extensions for CDT.cloud Blueprint
    • 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 electron package

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

Create a Preview Application (without packaging it)

yarn electron package:preview

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

Workspace and example files

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 electron package:preview
yarn electron test

Troubleshooting

Reporting Feature Requests and Bugs

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