Skip to content
This repository has been archived by the owner on Nov 6, 2020. It is now read-only.

Latest commit

 

History

History
249 lines (167 loc) · 11.2 KB

README.md

File metadata and controls

249 lines (167 loc) · 11.2 KB
Raw
❗ Important

Development of Cate Desktop has currently been discontinued if favor of the new Cate Web UI (Cate App) that rns in all modern browsers. To use Cate in stand-alone mode, follow suggestions made in Cate's README. Note, many browsers allow installing Cate App as a Desktop App (it's a progressive web application).

cate-desktop

Build Status Build status

Overview

cate-desktop provides a desktop GUI for Cate, the ESA CCI Toolbox.

cate-desktop

Building from Sources

Setting up Cate Core

Cate Desktop requires the Cate Python environment to be installed on your system. Follow the instruction in Cate's README first. The short version is that you'll first need to install a Miniconda 3.x, then:

$ git clone https://github.com/CCI-Tools/cate.git

If you've already cloned the repo make it up to date by

$ git pull

Then, with am Anaconda/Miniconda 3.x installed create a new Python environment for Cate and install the sources

$ cd cate
$ conda env create
$ source activate cate-env
$ python setup.py develop

With a successfully installed Cate sources make sure you can start Cate's WebAPI service, which will be later used by Cate Desktop:

$ cate-webapi-start --port 9090

You can stop it by hitting CTRL+C or from another shell:

$ cate-webapi-stop --port 9090

Setting up Cate Desktop

Check out Cate Desktop from GitHub:

$ git clone https://github.com/CCI-Tools/cate-desktop.git
$ cd cate-desktop

If you've already cloned the repo, you make it up-to-date by pulling in the latest changes:

$ git pull

The only development tool initially required to build cate-desktop is Node.js. We use the long-term support (LTS) version of Node. After installing Node.js, we use its package manager npm to install all other package dependencies. This step is also required if a file named package.json was updated during a git pull command (see above).

$ npm install

The project cate-desktop is programmed in TypeScript. Therefore all TypeScript sources must be compiled to JavaScript first. This step is required if there are any changes during a git pull command (see above).

$ npm run compile

To finally run the Cate Desktop application, make sure Cate WebAPI service is up and running (see above) and type

$ npm start

Cate Desktop Development

The following commands are of interest for developers.

This is how you can execute all unit-level tests (optional):

$ npm test

and this is how to perform end-to-end tests (optional):

$ npm run test:e2e

To build the installer executables for the current platform:

$ npm run dist

And to build binary packages:

$ npm run pack

To clean compilation results:

$ npm run clean

To get rid of all outputs since cloning the repo:

$ npm run clean:all

Development Settings

In ${HOME}/.cate/preferences.json:

  • set "debugWorldView": true to log Cesium globe operations
  • set "devToolsOpened": true to open the Electron dev-tools window when the apps starts
  • set "offlineMode": true to force offline mode
  • set "forceAppBar": true to show the application bar that is used in the non-Electron version of Cate

Environment variables:

  • set REACT_APP_CATE_USERNAME=YOUR_NAME and REACT_APP_CATE_PASSWORD=YOUR_PASSWORD to use default CateHub username and password.

Frameworks and Libraries in use

The following frameworks and libraries are currently used in Cate's production code:

  • Electron, to build cross platform desktop apps with JavaScript, HTML, and CSS.
  • React, a javascript library for building user interfaces.
  • Redux, a predictable state container for JavaScript apps. We use the following middleware:
    • redux-thunk, allows to write action creators that return a function instead of an action
    • redux-logger, a logger middleware for Redux
  • Blueprint, a React UI toolkit.
  • Cesium, an open-source JavaScript library for world-class 3D globes and maps.
  • react-ace Code editor component

Utilities:

  • reselect, Selector library for Redux.
  • deep-equal, Node's assert.deepEqual() algorithm as a standalone module.
  • electron-devtools-installer is and easy way to install Chrome's DevTool extensions into Electron.
  • Oboe.js for loading JSON using streaming.
  • react-linkify to parse links (urls, emails, etc.) in text into clickable links.

Development Tools and Libraries in use

For building:

  • typescript provides Microsoft's TypeScript compiler tsc.
  • electron-builder is used to create distribution packages and installers.

For testing:

  • ts-node a TypeScript execution environment for Node.js and Electron.
  • mocha JavaScript unit-testing framework for Node.js and Electron.
  • chai JavaScript assertion library that adds Behaviour Driven Development (BDD) API to mocha.
  • spectron for end-to-end testing of the GUI applications. See script test:e2e in package.json.
  • react-addons-test-utils makes it easy to test React components in any testing framework.
  • jsdom-global is used to inject document, window and other DOM API into our Node.js environment so we can run tests ("react-ace").

Other tools:

  • rimraf is Node's version of Unix rm -rf.

Project Structure

This is how the directory structure will look like after cloning the repo:

cate-desktop/
├── app/                     # Electrion application directory 
│   ├── resources/           # Application resources: icons, images
│   ├── main.js              # Called from Electron's main process, see ./package.json
│   ├── renderer.js          # Called by Electron's renderer process, see ./index.html
│   ├── index.html           # Loaded by Electron's main process
│   └── package.json         # Electron application definition 
├── src/                     # TypeScript application module sources
│   ├── common/              # Common code running in both Electron's main and renderer processes
│   │   └── **/*.ts          #   TypeScript files
│   ├── main/                # Code running in Electron's main process (with Node API access)
│   │   └── **/*.ts          #   TypeScript files
│   └── renderer/            # Code running in Electron's renderer process (w/o Node API access)
│       ├── **/*.ts          #   TypeScript files
│       └── **/*.tsx         #   TypeScript JSX files
├── e2e/                     # End-to-end tests
│   └── **/*.js              #   JavaScript files
├── .editorconfig            # see http://editorconfig.org/
├── tsconfig.json            # TypeScript compiler (tsc) configuration
└── package.json             # Node package definition

cate-desktop uses a two-package.json project structure.

  • Development dependencies are in cate-desktop/package.json
  • Application dependencies are in cate-desktop/app/package.json

The command npm install performs a post-installation step in which the tool install-app-deps (comes with electron-builder) installs application dependencies of cate-desktop/app/package.json. After this, Node's node_modules directories are created

cate-desktop/
├── node_modules/ 
└── app/                     
    └── node_modules/

After compilation, i.e. npm run compile, the app directory is populated with compiled JavaScript files:

cate-desktop/
└── app/                     
    ├── main/                # Code running in Electron's main process (with Node API access)
    │   └── **/*.js          #   JS files compiled from *.ts files in src/main 
    └── renderer/            # Code running in Electron's renderer process (w/o Node API access)
        └── **/*.js          #   JS files compiled from *.ts and *.tsx files in src/renderer

After distribution (installer) building, i.e. npm run dist:

cate-desktop/
└──  dist/                   # Distributable application binaries
     └── *.*

The setup of this project was inspired by

The project onshape-desktop-shell uses a similar setup.

This project currently doesn't use any other build tools apart from npm and tsc, the TypeScript compiler. We'll one day want to have hot loading into Electron and then use a tool such as webpack. The TypeScript article React & Webpack describes how to use TypeScript with webpack and React.

TODO