A super modular Ionic starter application
JavaScript HTML CSS Batchfile Shell
Latest commit 1c16527 Nov 29, 2016 @skounis skounis committed on GitHub Update README.md

README.md

Supermodular Ionic

A super modular Ionic starter application.

Are you interesting in Ionic 2?

Dependecies, Run and Build

Install NodeJS dependencies

Run npm install to install all needed dependencies.

Install Plugins and Javascript dependencies

Linux/MacOX

Run ./install.sh to install all needed plugins and dependencies

Windows Users

Similarly, Windows users should run install.bat.

Run the app

Use grunt serve -l to run the app in browser and watch for changes in code

or

use grunt serve to just run the app for a browser preview

or

use grunt serve --lab to run the app in a browser on two platforms at the same time.

Add a platform

$ grunt platform:add:<platform>

Supported Cordova platforms:

$ grunt platform:add:ios
$ grunt platform:add:android

Build the app

$ grunt build

Εmulate the app on simulator

iOS:

$ grunt emulate:ios

Android:

$ grunt emulate:android

For more information, see Ionic Framework Generator's instructions.

Plugins installation

Use the following commands and install all the plugins required by the app:

$ cordova plugin add {plugin id or url}

eg:

cordova plugin add cordova-plugin-inappbrowser

Used Cordova plugins

In case that the required Cordova plugins are not installed while installing NodeJS dependencies, Cordova's command mentioned previously can be used to install the following plugins:

  • cordova-plugin-device - This plugin defines a global device object, which describes the device's hardware and software.
  • cordova-plugin-console - This plugin is meant to ensure that console.log() is as useful as it can be. It adds additional function for iOS, Ubuntu, Windows Phone 8, and Windows.
  • com.ionic.keyboard - It provides functions to make interacting with the keyboard easier, and fires events to indicate that the keyboard will hide/show.
  • cordova-plugin-inappbrowser - Provides a web browser view. It could be used to open images, access web pages, and open PDF files.
  • cordova-plugin-geolocation - Grab the current location of the user, or grab continuous location changes
  • nl.x-services.plugins.socialsharing - Share images, text, messages via Facebook, Twitter, Email, SMS, WhatsApp, etc using this plugin (https://github.com/EddyVerbruggen/SocialSharing-PhoneGap-Plugin.git).
  • de.appplant.cordova.plugin.email-composer - The plugin provides access to the standard interface that manages the editing and sending an email message.
  • cordova-plugin-network-information - This plugin provides an implementation of an old version of the Network Information API. It provides information about the device's cellular and wifi connection, and whether the device has an internet connection.
  • cordova-plugin-whitelist - This plugin implements a whitelist policy for navigating the application webview on Cordova 4.0
  • cordova-plugin-transport-security - Cordova / PhoneGap Plugin to allow 'Arbitrary Loads' by adding a declaration to the Info.plist file to bypass the iOS 9 App Transport Security

Branches naming convention

Each branch is related to the Ionic framework version the source code is based on. Currently, there are the following branches:

  1. master: Main development source code
  2. 1.1-1.x: Source code maintenance based on Ionic 1.1.x

Credits

Third Party Licences