Cesium

Unhosted webapp client for any Duniter crypto-currency.

Manage your wallet, certify your friends, and more !

Try it !

• on Ğ1-test currency: http://g1-test.duniter.fr
• on Ğ1 currency (production use): https://g1.duniter.fr

Installation

On desktop computer

To use Cesium from your desktop computer :

• Debian or Windows:
  • Download the latest release.
  • Choose the desktop packaging (cesium-desktop-vX.Y.Z-*)
  • Execute the downloaded file, and follow installation steps;
• Other operating systems:
  • Choose the web packaging (cesium-vX.Y.Z-web.zip);
  • Unpack the archive into a empty folder;
  • Open the file index.html in your web browser;

On web server

Cesium can be easily installed on most web server :

• Download the latest release. Choose the web packaging (cesium-vX.Y.Z-web.zip);
• Unpack in a empty directory;
• Configure a virtual host, to use previous directory as root. Check the file index.html exist in the root directory.

For Linux distribution, a installation script could also be used to:

• Download the latest release
• Unpack archive into the directory ./cesium. Existing files will be override.

curl -kL https://raw.githubusercontent.com/duniter/cesium/master/install.sh | bash

or:

wget -qO- https://raw.githubusercontent.com/duniter/cesium/master/install.sh | bash

Note: You may need root permission to write files. If so just replace | bash with | sudo bash.

Yunohost package

There is a package for YunoHost self-hosting distribution.

Configuration

To change default configuration, on a web server installation:

• Edit the file config.js, and set default properties:

angular.module("cesium.config", [])
.constant("csConfig", {
  "fallbackLanguage": "en",
  "rememberMe": false,
  "timeWarningExpireMembership": 5184000,
  "timeWarningExpire": 7776000,
  "useLocalStorage": true,
  "useRelative": true,
  "decimalCount": 4,
  "helptip": {
    "enable": true,
    "installDocUrl": "https://github.com/duniter/duniter/blob/master/doc/install-a-node.md"
  },
  "node": {
    "host": "gtest.duniter.org",
    "port": "10900"
  },
	"plugins": {
		"es": {
			"enable": "false",
			"host": "data.gtest.duniter.fr",
			"port": "80"
		}
	},
	"version": "0.9.7",
	"build": "2017-01-17T08:27:57.915Z"
});

• Configure a Duniter node:

  • set node.host and node.port to the default node address.

• Configure the optional extension for ElasticSearch Duniter4j node

  • set plugins.es.host and plugins.es.port to the default ES node address.

  • set plugins.es.enable with [true|false] to change the default extension state.

To learn more about configuration options, see the detailed documentation.

License

This software is distributed under GNU GPLv3.

Development Guide

Prerequisite

To build Cesium, you will have to:

• Installing build tools:

 sudo apt-get install build-essential

• Installing nvm

  wget -qO- https://raw.githubusercontent.com/creationix/nvm/v0.31.0/install.sh | bash

Then reload your terminal, for instance by executing the commande bash

• Configure NodeJS to use a version 8:

  nvm install 5

• Installing node.js build tools:

   npm install -g gulp bower@1.8.0 cordova@6.5.0 ionic@1.7.16

Get the source code

• Getting source and installing project dependencies:

  git clone https://github.com/duniter/cesium.git
  cd cesium
  npm install

• Installing Cordova plugins (need for platforms specific builds)

  ionic state restore
  ionic browser add crosswalk@12.41.296.5

Prepare environment, then compile and launch

• To configure your build environment :

  • Add your environment config into app/config.json

  • Update default configuration, using the command:

  gulp config --env <your_env_name> 

This will update the configuration file used by cesium, at www/js/config.json.

• Compiling and running Cesium:

  npm start

or alternative: ionic serve

Best pratices for development

Cesium could be run on phone devices. Please read performance tips on AgularJS + Ionic before starting to contribute. Read also Angular performance for large applicatoins.