IONIC 2 Boilerplate
A ionic 2 boilerplate for starting new projects. This boilerplate will follow the best practices for angular and ionic development.
Table of Contents
Features
- Ionic RC1
- Es-Lodash
- NVM
- BetterScripts for npm
- ENV variables from package.json injected automatically by rollup
- Continuous Integration with Gitlab CI see here for info
- Automatic apk only when pushing to release branch
- Automatic ipa through ionic package only when pushing to release branch
- Docker image
- Tests
- Unit tests with karma
- E2E tests with protractor
- Screenshot reporter for protractor
Coverage with istanbul(see issue #5)- Gitlab badge see here for info
- Linting
- GIT
- Workflow with Commitizen
- Automatic changelog
- Automatic alignment of app version in config.xml from package.json through cordova hook
Roadmap
- Automatic download .ipa in gitlab artificts
- Documentation with typedoc (waiting a new release that supports ts 2.0)
Installation & Configuration
Pre-Install Commands
npm i -g cordova ionic
gem install scss_lint
ionic state restore
./node_modules/.bin/webdriver-manager update
Note: you should have ruby 2 installed to run scss-lint.
NPM scripts commands
| Task | Description |
|---|---|
dev |
run ionic serve |
build |
Full production build. Use --dev flag for dev build. |
release |
generate changelog based on commits |
push |
shortcut for git push origin master --follow-tags |
lint |
lint with tslint |
scss-lint |
lint scss |
test |
runs Karma test |
test:watch |
runs Karma test watching for edits (usefull for TDD) |
e2e |
runs e2e protractor tests |
e2e:interactive |
runs e2e protractor tests in interactive mode |
outdated |
search npm packages for outdated dependencies |
ios:dev |
build .ipa using dev environment vars |
ios:release |
build .ipa with production environment vars |
android:dev |
build .apk using dev environment vars |
android:release |
build .apk with production environment vars |
Gitlab CI Configuration
- To get code coverage percentage badge use the following regexp:
All files(?:\s*\|\s*\d*\.?\d+\s*){3}\|\s*((\d*\.?\d+))\s*\|in Gitlab CI/CD pipelines. - To get the automatic .ipa from ionic package first setup a ionic.io profile with certificates for ios. Secondly add the following Secret variables in Gitlab. N.B. Be sure to don't show Build results (edit project settings) for your repo otherwise those vars could be exposed.
| Key | Description |
|---|---|
IONIC_LOGIN_EMAIL |
Your ionic.io email |
IONIC_LOGIN_PASSWORD |
Your ionic.io password |
IONIC_PACKAGE_BUILD_RELEASE |
(Optional) Indicate whether this is a release build. Possible values are true or false. Defaults to false. |
IONIC_PACKAGE_BUILD_PROFILE |
Security profile to use for the build, as defined in Ionic.io console. |
Tips
Optional Libraries
If you want everything to just work nicely, use es2015 libraries like lodash-es instead of lodash (NOTE: [actually there are no typings available] (DefinitelyTyped/DefinitelyTyped#7691), for this reason I used a wildcard in declarations.d.ts to disable every error regarding imports of libs without typings). Also in the case of lodash try to do: import map from 'lodash-es/map' rather than import { map } from 'lodash-es'. See here for further info. To find examples on how to import 3rd party libs with ionic and rollup see here and here
- Error logging: Sentry
- Database: PouchDB or Ionic-storage. Don't use localstorage as it can be deleted by OS to free memory.
- Time and Dates: MomentJs
- NGRX pattern/library if you plan to make a big app.
Git Workflow
- Optionally you can use Git flow
- If you want to bump the changelog, run "npm run release"
- This repo has a mirror repo in gitlab for CI after every push on master you will get automatically all tests and lints run. To get .ipa and .apk build you need to push to the release git branch. The reason is to avoid unnecessary builds (free limit is 100/month) for ios.
- You should consider to write a shortcut in .bashrc for the following commands
Workflow:
git add .
npm run commit // this will run tslint + scss lint + commit
npm run push // this will run unit tests + push to master
// now check on GITLAB if there are no errors, than if you want push your commits to the release branch to get automatic ipa and apk
Useful Links
Ionic & Cordova
- Avoid the use of ionic state commands and also ionic plugin/platform. Use directly cordova prepare (or cordova plugin/platform). Also save your plugin/platform only inside config.xml, not package.json to avoid confusion. See this for further informations.
Webstorm
- Set code style for typesript:
- {import} -> { import }
- import * from "lodash" -> import * from 'lodash'
- Set typescript settings to be used with the version inside node_modules instead of the bundled one (1.8)
- Don't activate typescript compiler.
- Enable tslint in settings
- Download scss lint plugin and enable it
Windows
- You should avoid Windows. I tried a lot of times and at the end found myself switching to a Mac VM or Hackintosh or Linux distro. The following tips are not resolutive but can help you set up a nice environment.
- Instead of windows terminal I used cmder.
- If you use Webstorm. Set terminal settings as follow -> "cmd.exe" /k ""%CMDER_ROOT%\vendor\init.bat""
- Remember to re-start webstorm every time you make a change to the terminal.
- npm install --global --production windows-build-tools //node-gyp fix
- Set webstorm to write with line endingds LF (mac os or unix)
- To avoid git warnings: git config core.autocrlf false
- e2e commands is not working on windows, because the python server can't be launched. As a workaround add START /B before python -m and remove & at the end of the line in package.json. Anyway you will have to kill manually the process every time after every execution.