Ionic 2
A comprehensive Ionic starter kit with testing, CI/CD, and build tools for hybrid mobile app development.
What is Ionic 2?
Ionic2 Boilerplate is a starter kit for Ionic 3 applications that comes pre-configured with a comprehensive set of development tools. It includes testing frameworks, build systems, linting, and CI/CD pipelines to help developers quickly start building hybrid mobile apps with best practices in place.
Mobile developers using Ionic and Angular who want a production-ready foundation with integrated testing and deployment workflows.
It saves significant setup time by providing a battle-tested configuration with tools like Karma, Protractor, and GitLab CI out of the box, ensuring code quality and streamlined deployment from the start.
Overview
✨ An Ionic Starter kit featuring Tests, E2E, Karma, Protractor, Jasmine, Istanbul, Gitlab CI, Automatic IPA and APK, TypeScript 2, TsLint, Codelyzer, Typedoc, Yarn, Rollup, and Webpack 2
Use Cases
Best For
- Starting new Ionic 3 projects with a pre-configured testing environment
- Teams needing integrated CI/CD for automatic IPA and APK builds
- Developers who want enforced code quality with TSLint and SCSS Lint
- Projects requiring comprehensive documentation generation with Typedoc
- Apps that need both unit and end-to-end testing setups
- Streamlining hybrid mobile app development with best practices
Not Ideal For
- Projects targeting Ionic 4 or newer versions, as it's built for Ionic 3 which is outdated
- Teams using CI/CD platforms other than GitLab CI, due to its specific configuration and optimizations
- Developers needing a lightweight setup for quick prototypes, given its comprehensive but complex tooling
Pros & Cons
Pros
Includes Karma for unit tests, Protractor for E2E tests, and Istanbul for code coverage, ensuring robust testing workflows out of the box.
Pre-configured GitLab CI automates IPA and APK generation on release branches, streamlining deployment with secret variable management.
Uses TSLint with Codelyzer and SCSS Lint to enforce Angular and Sass guidelines, maintaining consistency across the codebase.
Incorporates Yarn for dependency management and BetterScripts for enhanced npm scripts, improving workflow efficiency and reliability.
Includes Typedoc for automatic code documentation, aiding in project maintainability and team onboarding.
Cons
Targets Ionic 3, which is no longer actively supported, missing newer features and community updates from Ionic 4+.
Requires installation of multiple global dependencies like Ruby for SCSS lint and specific Node versions, increasing setup time and potential compatibility issues.
Optimized solely for GitLab CI; adapting to other platforms like GitHub Actions or Jenkins requires significant reconfiguration effort.
The README advises avoiding Windows and offers only partial workarounds, indicating limited cross-platform compatibility and tooling.
Frequently Asked Questions
Related Projects
Ionic 2 Advanced ComponentsA project full of ionic 3 components and samples - to make life easier :)
Ionic Official Starter TemplatesStarter templates for Ionic apps, used by the Ionic CLI
Ionic Boilerplate✨ An Ionic Starter kit featuring Tests, E2E, Karma, Protractor, Jasmine, Istanbul, Gitlab CI, Automatic IPA and APK, TypeScript 2, TsLint, Codelyzer, Typedoc, Yarn, Rollup, and Webpack 2
OCR Scan App:camera: Simple Ionic app using ocrad.js
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.