development_guide.md

Development Guide

In a post-it

# Install NodeJS v12
nvm use 12
npm install -g yarn 

# Clone and compile from source
git clone [email protected]:duniter-gchange/gchange-client.git
cd gchange-client
yarn

# Run the App !
yarn run start

Step by step

Prerequisite

To build Gchange, you will have to:

• Installing build tools:

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

• Installing nvm

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

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

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

• Configure NodeJS to use a version 12:

    nvm install 12

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

     npm install -g yarn gulp [email protected] @ionic/cli web-ext

Get the source code

1. Getting the source code:

     git clone [email protected]:duniter-gchange/gchange-client.git

2. Install project dependencies:

      cd gchange-client
      yarn

3. Installing Cordova plugins (required to build Android and iOS artifacts):

      export JAVA_HOME=/path/to/jdk-8
      export PATH=$JAVA_HOME/bin:$PATH
      ionic cordova prepare

   This should create new directories platforms/android and platforms/ios.

   As a reminder: make sure your command line has been well configured:

   • You must place yourself in the directory of the application: cd gchange-client
   • and working with NodeJs v12: nvm use 12 (please check using the command node --version)

Prepare configuration file

Configure your environment :

1. Add your environment config into app/config.json

2. 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.

Compile and launch

To compile and launch, run:

  yarn run start

or alternative: npm start or ionic serve

Build artifacts

Gchange can be build:

• as an unhosted web applicationa;
• for Android;
• as a Web extension for Mozilla Firefox or Chrome/Chomium;

Time to code !

Pull request

For each pull request, please create an issue first.

Best practices for development

ğchange could be run on phone devices. Please read performance tips on AgularJS + Ionic before starting to contribute.

Read also Angular performance for large applicatoins.