ionic-framework README

The project's README from github.com/ionic-team/ionic-framework. As one markdown file: README.md.

Ionic

Ionic

Ionic is an open source app development toolkit for building modern, fast, top-quality cross-platform native and Progressive Web Apps from a single codebase with JavaScript and the Web.

Ionic is based on Web Components, which enables significant performance, usability, and feature improvements alongside support for popular web frameworks like Angular, React, and Vue.

Ionic Framework is released under the MIT license. PRs welcome! Follow @IonicFramework Official Ionic Discord

Quickstart · Documentation · Contribute · Blog
Community: Discord · Forums · Twitter

Packages

Project Package Version Downloads Links
Core @ionic/core version NPM Downloads README.md
Angular @ionic/angular version NPM Downloads README.md
Vue @ionic/vue version NPM Downloads README.md
React @ionic/react version NPM Downloads README.md

Looking for the ionic-angular package? Ionic 3 has been moved to the ionic-v3 repo. See Earlier Versions.

Getting Started

Start a new project by following our documentation. We would love to hear from you! If you have any feedback or run into issues using our framework, please file an issue on this repository.

Migration Guides

Already have an Ionic app? These guides will help you migrate to the latest versions.

Examples

The Ionic Conference App is a full featured Ionic app. It is the perfect starting point for learning and building your own app.

Contributing

Thanks for your interest in contributing! Read up on our guidelines for contributing and then look through our issues with a help wanted label.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Earlier Versions

The source code for earlier versions of the Ionic Framework may exist in other repositories. Please open issues and pull requests in their respective repositories.

ionic-framework (ionic-team/ionic-framework)

Searching Database…

What is this?Ionic is an open source app development toolkit for building modern, fast, top-quality apps with JavaScript and the Web.
Is it an app I install, or npm packages I code against?The latter: Ionic ships as code — a framework-agnostic core package (@ionic/core) plus official wrappers for Angular, Vue, and React that you build your app against.
How do I start a new app with it?The README keeps it to one pointer: start a new project by following the official Ionic documentation.
My app is still on an old Ionic version — will this repo help?Not directly: Ionic 2/3 moved to the ionic-v3 repo and Ionic 1 to ionic-v1, so issues and pull requests for those versions belong there.
Where do the apps I build with it actually run?Native-quality iOS and Android apps plus Progressive Web Apps, all built from a single codebase.
Is there a finished example app I can learn from?Yes — the Ionic Conference App is a full featured Ionic app the README calls the perfect starting point for building your own, and it comes in Angular, React, and Vue editions.
What is Stencil and where does it fit in?Stencil is what the README says Ionic is based on; it is credited for significant performance, usability, and feature improvements alongside support for popular web frameworks.
Is this repo the current version of Ionic?Yes — this is the latest line: the migration guides run from v3 all the way up to v8.
Creator
ionic-team
Size
1.8 GB
Stars
52.7K
Age
13y
Commits · 90 Days