https://github.com/nuxt-modules/ionic

Batteries-included, zero-config Ionic integration for Nuxt
https://github.com/nuxt-modules/ionic

android hacktoberfest ionic ios mobile nuxt nuxt-module

Last synced: about 2 months ago
JSON representation

Batteries-included, zero-config Ionic integration for Nuxt

• Host: GitHub
• URL: https://github.com/nuxt-modules/ionic
• Owner: nuxt-modules
• License: mit
• Created: 2022-06-17T23:05:38.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-15T10:48:53.000Z (5 months ago)
• Last Synced: 2024-04-15T14:01:47.496Z (5 months ago)
• Topics: android, hacktoberfest, ionic, ios, mobile, nuxt, nuxt-module
• Language: TypeScript
• Homepage: https://ionic.nuxtjs.org
• Size: 2.96 MB
• Stars: 343
• Watchers: 9
• Forks: 36
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![@nuxtjs/ionic](./docs/public/cover.jpg)](https://ionic.nuxtjs.org)

# Nuxt Ionic

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![Github Actions][github-actions-src]][github-actions-href]

[![Codecov][codecov-src]][codecov-href]

> [Ionic](https://ionicframework.com/docs/) integration for [Nuxt](https://nuxtjs.org)

- [✨  Changelog](https://github.com/nuxt-modules/ionic/blob/main/CHANGELOG.md)

- [📖  Read the documentation](https://ionic.nuxtjs.org)

- [▶️  Online playground](https://stackblitz.com/github/nuxt-modules/ionic/tree/main/playground)

## Features

**⚠️ `@nuxtjs/ionic` is currently a work in progress. ⚠️**

- Zero-config required

- Auto-import Ionic components, composables and icons

- Ionic Router integration

- Pre-render routes

- Mobile meta tags

- Works out-of-the-box with [Capacitor](https://capacitorjs.com/) to build mobile apps

**In progress**

- [ ] PWA Elements [#14](https://github.com/nuxt-modules/ionic/issues/14)

## Usage

👉 Check out https://ionic.nuxtjs.org.

## 💻 Development

- Clone this repository

- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`

- Install dependencies using `pnpm install`

- Stub module with `pnpm dev:prepare`

- Run `pnpm dev` to start [playground](./playground) in development mode

## License

Made with ❤️

Published under the [MIT License](./LICENCE).

[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/ionic?style=flat-square

[npm-version-href]: https://npmjs.com/package/@nuxtjs/ionic

[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/ionic?style=flat-square

[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/ionic

[github-actions-src]: https://img.shields.io/github/actions/workflow/status/nuxt-modules/ionic/ci.yml?style=flat-square&branch=main

[github-actions-href]: https://github.com/nuxt-modules/ionic/actions?query=workflow%3Aci

[codecov-src]: https://img.shields.io/codecov/c/gh/nuxt-modules/ionic/main?style=flat-square

[codecov-href]: https://codecov.io/gh/nuxt-modules/ionic