Skip to content

Commit

Permalink
feat(README): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pwambach committed Mar 9, 2020
1 parent bb5b56b commit 9fd979a
Showing 1 changed file with 78 additions and 1 deletion.
79 changes: 78 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,79 @@
# esa-climate-from-space
Climate from Space application for ESAs CCI+ program.

## Climate from Space application for ESAs CCI+ program.

### Links

- Staging: https://storage.googleapis.com/esa-cfs-versions/web/develop/index.html
- Live: https://storage.googleapis.com/esa-cfs-versions/web/master/index.html
- Releases: https://storage.googleapis.com/esa-cfs-versions/web/${VERSION}/index.html (e.g. `${VERSION} = 0.4.0`)

### Team

- PM Ubilabs: Patrick Mast <mast@ubilabs.net>
- Dev Ubilabs: Philipp Wambach <wambach@ubilabs.net>
- Dev Ubilabs: Katherina Marcenko <marcenko@ubilabs.net>
- Client: ESA

## Native Electron App

### Download

Besides the web version we also deliver a native Electron app to download and run on a local machine. This app also offers a "Safe for Offline Usage" feature which allows to download data and view it later without an internet connection.

The native app releases can be downloaded in the GitHub repo's "release" section or directly from:

- Windows `https://storage.googleapis.com/esa-cfs-versions/electron/master/esa-climate-from-space-${VERSION}-win.exe`
- MacOs `https://storage.googleapis.com/esa-cfs-versions/electron/master/esa-climate-from-space-${VERSION}-mac.zip`
- Linux `https://storage.googleapis.com/esa-cfs-versions/electron/master/esa-climate-from-space-${VERSION}-linux.zip`

Note: Be sure to replace the `VERSION` number e.g. (`0.4.0` -> `https://storage.googleapis.com/esa-cfs-versions/electron/develop/esa-climate-from-space-0.4.0-win.exe`)

### Installation

To run the native app just run the `.exe` file (Windows) or unpack the `.zip` archive (Linunx/MacOS) and run the containing app/binary file.

## Development

### Requirements

Following software is required to develop for this project:

- `node.js (>= 10)`
- `npm`

### Installation

After cloning the repository, install all dependencies:

```sh
npm install # install new dependencies
```

### Develop

Run the following command to start the server on localhost:

```sh
npm start # start the server
```

### Build Web

Run the following command to build a production ready version of the web part:

```sh
npm run build
```

The final output will be in a folder called `dist` in the project's root directory.

### Build Native Electron App

Run the following command to build a production ready version of the web part:

```sh
npm run electron:build
```

The final output will be in a folder called `dist-electron` in the project's root directory.

0 comments on commit 9fd979a

Please sign in to comment.