Ionic Boilerplate
A comprehensive Ionic starter kit with testing, CI/CD, and build automation for hybrid mobile apps.
What is Ionic Boilerplate?
Ionic Boilerplate is a starter kit for building hybrid mobile applications with the Ionic framework. It provides a pre-configured project structure with integrated testing, linting, CI/CD pipelines, and build automation to accelerate development. The kit solves the problem of repetitive setup by offering a production-ready foundation that follows best practices.
Mobile developers and teams building cross-platform apps with Ionic and Angular who want a standardized, automated workflow. It's ideal for projects requiring robust testing, continuous integration, and streamlined deployment.
Developers choose this boilerplate because it bundles essential tools and configurations into one package, saving significant setup time. Its emphasis on testing, code quality, and automation ensures maintainable apps, while the GitLab CI integration simplifies deployment.
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 projects with a production-ready setup
- Teams needing integrated unit and E2E testing from day one
- Projects requiring automated CI/CD pipelines for mobile apps
- Developers who prioritize code quality with linting and standards
- Building apps that need automatic IPA/APK generation
- Setting up a structured Git workflow with automated changelogs
Not Ideal For
- Projects targeting Ionic 4 or newer versions, as this boilerplate is built on Ionic 3
- Teams using CI/CD platforms other than GitLab, due to heavy pre-configuration for GitLab CI
- Developers on Windows systems, since the README strongly advises against Windows and recommends Mac or Linux
- Small projects or prototypes needing a lightweight setup without extensive testing and automation overhead
Pros & Cons
Pros
Includes unit tests with Karma and Jasmine, plus E2E tests with Protractor and screenshot reporting, ensuring robust app quality from the start.
Pre-configured GitLab CI with Docker support, automatic IPA/APK builds, and code coverage badges, streamlining deployment and reducing manual work.
Enforces standards with TSLint, Codelyzer, and SCSS Lint following Sass Guidelines, promoting consistent and maintainable code.
Supports both Webpack and Rollup for bundling, with scripts for dev and production builds, offering adaptability based on project needs.
Integrates Commitizen for standardized commits and automatic changelog generation, enhancing team collaboration and version tracking.
Cons
Based on Ionic 3, which lacks features and support compared to newer versions, potentially limiting modern app development.
Requires installation of multiple tools like Ruby for SCSS Lint and specific Node versions, with platform limitations especially on Windows, increasing initial effort.
Heavily integrated with GitLab CI, making it cumbersome to adapt to other CI/CD services like GitHub Actions or Jenkins.
Roadmap notes missing elements like automatic .ipa download in GitLab artifacts, indicating gaps in the promised automation suite.
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 2✨ 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.