/generator-jhipster-ionic

Ionic for JHipster 💥

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Ionic for JHipster

NPM version Build Status Dependency Status

A JHipster Module that generates an Ionic Client

Introduction

This is a JHipster module. You can use it to generate an Ionic app that talks to a JHipster backend. It uses the Ionic JHipster Starter as a base template, then applies functionality (e.g. entity generation) on top of it.

To learn more about this module, see Use Ionic for JHipster to Create Mobile Apps with OIDC Authentication.

Prerequisites

As this is a JHipster module, we expect you to have an existing JHipster app and Ionic already installed.

Or simply:

npm i -g generator-jhipster ionic

Installation

To install this module:

npm install -g generator-jhipster-ionic yo

To update this module:

npm update -g generator-jhipster-ionic

Usage

Create a JHipster app using yo jhipster, or a backend-only with yo jhipster:server. Choose JWT or OAuth 2.0 as the authentication type.

In a directory alongside your JHipster app, run this module. This will create an Ionic app for you and install the necessary JHipster files for it to communicate with the backend.

yo jhipster-ionic

Entity Generator

To generate entities, run yo jhipster-ionic:entity <name>.

Testing

You can run unit tests with:

npm test

And e2e tests with:

npm run build --prod && npm run e2e

See the testing section of the Ionic JHipster Starter for more information.

Contributing

Please read our guidelines before submitting an issue. If your issue is a bug, please use the bug template pre populated here. For feature requests and queries you can use this template.

License

Apache-2.0 © Okta