Initial Setup

This page describes the initial setup steps. Follow the steps to get the app setup and running on your dev environment, as well as on your devices.

Installing Ionic

Ionic apps are created and developed primarily through the Ionic command-line utility. The Ionic CLI is the preferred method of installation, as it offers a wide range of dev tools and help options along the way.‌

Install the Ionic CLI

Before proceeding, make sure the latest version of Node.js and npm are installed. See Environment Setup for details. Install the Ionic CLI globally with npm:

$ npm install -g ionic

Node & npm‌

Almost all tooling for modern JavaScript projects is based in Node.js. The download page has prebuilt installation packages for all platforms. We recommend selecting the LTS version to ensure best compatibility.‌

Node is bundled with npm, the package manager for JavaScript.‌

To verify the installation, open a new terminal window and run:

$ node --version
$ npm --version

This starter app will run best with node 12.x +‌

Node and NPM version are constantly updated so if you face any issue in setup, or warnings in npm audit feel free to contact us.‌

Git

​Git is a distributed version-control system for tracking changes in source code during software development. Although it's not required, we highly recommend using Git for your app development.‌

First, install the command-line utility from the download page. For a GUI client, we recommend SourceTree. To verify the installation, open a new terminal window and run:

$ git --version

You can also use Git CLI to perform all Git related tasks. A good description of all Git CLI commands is given here.‌

Install the app dependencies

After you have Ionic installed, you have to install all the dependencies required by the app. These dependencies are listed in package.json file in the root of the project. To do this just run the following command using a terminal inside your ionic app folder path.

// Move into your project directory
$ cd myApp
// Install dependencies
$ npm install

If you are using latest NPM, you might see an audit report after the installation is completed. If you see any vulnerability marked as high , please contact us regarding the same.‌

Code Editor

Personally we use VS Code , however, many people like Atom. You are free to choose any code editor you like.‌

Run the App

Now we have everything installed, we can test our Ionic App.‌

Remember to enter your own GOOGLE API KEY in the source code in the place of YOUR_API_KEY. Without this api key, many functionalities might not work, especially maps. Check the docs for more info

Go to Running the App section to see how to do it.