# Quick start guide

{% hint style="warning" %}
To use this apps your system must have NodeJS, cordova and Ionic installed on your machine.
{% endhint %}

## INSTALL REQUIRMENTS 

1. **Install NodeJS :**  First, make sure that [NodeJS](https://nodejs.org/en/) is installed on your computer. If NodeJS is not installed, please install the 8.x version of NodeJS. \
   For more information about the NPM packages Ionic uses, refer to “[Using NPM](https://ionicframework.com/docs/developer-resources/using-npm/)” section of Ionic official documentation.
2.  **Cordova and Ionic** This is a [Cordova](http://cordova.apache.org/) and [Ionic](http://ionicframework.com/) based application, so Cordova and Ionic should be installed on your computer for this application to run. Since this app targets iPhone and Android mobile devices, your environment should be properly configured and the corresponding SDK should be installed. If not you will be still able to run the application into a Browser **(in this case Natives Features wouldn't works !)**. \
   In order to install Ionic SDK for the creation/running of Ionic projects, run the command:

```
$ npm install -g ionic
```

In order to install Cordova, run the command:

```
 $ npm install -g cordova
```

For more information, please, check the “[Getting Started with Ionic](https://ionicframework.com/docs/intro/installation/)” sections in the official Ionic website.

{% hint style="info" %}
Please check [this youtube video](https://www.youtube.com/watch?v=BDDUpP5SUA8) in order to install & setup Ionic.
{% endhint %}

## RUN **THE APPLICATION** 

In the sections that follow, we will demonstrate the process of preparing your environment and running the project for the first time.                                             First your need to **Install project libraries.**

Open a **terminal window** and navigate to the **project source directory**. And run the following command:

```
 $ npm install
```

**Run the application (after the first-time preparations)** 

* **Run on local development server ( WEB )**

First you need to Navigate to **the project source directory** and run the application in the browser by taping this command on your command line:

```
$ ionic serve --lab
```

![](https://95637101-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LPldOR-zLunAcbQ7rlx%2F-LPuPTHKznSr0Ff2f69R%2F-LPuRGO1k2wcWWVusa5S%2FScreen%20Shot%202018-10-28%20at%2011.30.32.png?alt=media\&token=c5ebdd60-34ea-4ebc-8c33-b8b16d258551)

{% hint style="warning" %}
**NOTE:** Not all natives features will works unless if you run the apps on an **EMULATOR** or on a **REAL DEVICE**, check the instruction bellow to run the apps on Android & IOS devices.
{% endhint %}

{% content-ref url="build/build-android-version" %}
[build-android-version](https://marouanesouah.gitbook.io/cryptoz/build/build-android-version)
{% endcontent-ref %}

{% content-ref url="build/build-ios-version" %}
[build-ios-version](https://marouanesouah.gitbook.io/cryptoz/build/build-ios-version)
{% endcontent-ref %}