The Ionic 2 Super Starter 🎮
TypeScript HTML CSS JavaScript
Latest commit 4fe7d60 Jan 18, 2017 @mlynch mlynch committed on GitHub Merge pull request #67 from kesozjura/master
added more translations
Permalink
Failed to load latest commit information.
src Merge pull request #67 from kesozjura/master Jan 18, 2017
www Master import Dec 21, 2016
.gitignore File cleanup Dec 28, 2016
LICENSE fix(license): closes #70 Jan 17, 2017
README.md CLI Dec 22, 2016
package.json Update ng2-translate version Jan 7, 2017
super2.png Logo Dec 21, 2016

README.md

The Ionic Super Starter 🎮

Note: the Ionic Super Starter requires Ionic CLI 2.1.18 or greater.

The Ionic Super Starter is a batteries-included starter project for Ionic 2.x apps complete with pre-built pages, providers, , and best practices for Ionic development.

The goal of the Super Starter is to get you from zero to app store faster than before, with a set of opinions from the Ionic team around page layout, data/user management, and project structure.

The way to use this starter is to pick and choose the various page types you want use, and remove the ones you don't. If you want a blank slate, this starter isn't for you (use the blank type instead).

One of the big advances in Ionic 2 was moving from a rigid route-based navigation system to a flexible push/pop navigation system modeled off common native SDKs. We've embraced this pattern to provide a set of reusable pages that can be navigated to anywhere in the app. Take a look at the Settings page for a cool example of a page navigating to itself to provide a different UI without duplicating code.

Table of Contents

  1. Pages
  2. i18n (adding languages)

Pages

The Super Starter comes with a variety of ready-made pages. These pages help you assemble common building blocks for your app so you can focus on your unique features and branding.

The app loads with the FirstRunPage set to TutorialPage as the default. If the user has already gone through this page once, it will be skipped the next time they load the app.

If the tutorial is skipped but the user hasn't logged in yet, the Welcome page will be displayed which is a "splash" prompting the user to log in or create an account.

Once the user is authenticated, the app will load with the MainPage which is set to be the TabsPage as the default.

The entry and main pages can be configured easily by updating the corresponding variables in src/pages/pages.ts.

Please read the Pages readme, and the readme for each page in the source for more documentation on each.

Providers

The Super Starter comes with some basic implementations of common providers.

User

The User provider is used to authenticate users through its login(accountInfo) and signup(accountInfo) methods, which perform POST requests to an API endpoint that you will need to configure.

Api

The Api provider is a simple CRUD frontend to an API. Simply put the root of your API url in the Api class and call get/post/put/patch/delete

i18n

Ionic Super Starter comes with internationalization (i18n) out of the box with ng2-translate. This makes it easy to change the text used in the app by modifying only one file.

By default, the only language strings provided are American English.

Adding Languages

To add new languages, add new files to the src/assets/i18n directory, following the pattern of LANGCODE.json where LANGCODE is the language/locale code (ex: en/gb/de/es/etc.).

Changing the Language

To change the language of the app, edit src/app/app.component.ts and modify translate.use('en') to use the LANGCODE from src/assets/i18n/