development_guide.md

Development Guide

Prerequisite

To build Cesium, you will have to:

• Installing build tools:

 sudo apt-get install git wget curl unzip build-essential software-properties-common ruby ruby-dev ruby-ffi gcc make

• Installing nvm

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

If you are using fish shell, there is a dedicated plugin.

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

• Configure NodeJS to use a version 10: (WARNING: upper version will NOT work !)

  nvm install 10

• Installing node.js build tools, as global dependencies:

   npm install -g yarn gulp cordova ionic

Get the source code and dependencies

• Getting source and installing project dependencies:

  git clone git@git.duniter.org:clients/cesium-grp/cesium.git
  cd cesium
  yarn

• Installing Cordova plugins (need for platforms specific builds)

  ionic state restore

• This should create a new directory platforms/android

To remind: check that your command line is configured:

• You must place yourself in the directory of the application: cd cesium
• and be configured for NodeJs v6: nvm use 6 (please check using the command node --version)

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: yarn run start or ionic serve

• Open a web browser at address: localhost:8100. The application should be running.

Best practices 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.