Skip to content

merlinofcha0s/generator-jhipster-flutter

Repository files navigation


Generator npm version npm

Generate your Flutter mobile App (Android / iOS) for JHipster

This is a JHipster module.

Get started and (Full not yet) documentation on my blog here

What's inside

  • Screen
    • Main
    • Register
    • Login
    • User preferences
  • Theming
    • All styles in one place
    • Light theme for now
  • Full I18n support
    • EN, FR for now
    • Automatic generation with IntelliJ plugin or VS code plugin
    • Detecting device locale
    • Change language in user preferences UI
    • Apply the preferred locale instead of the device one
  • BLoC Architecture More informations
  • JSON serializer / deserializer Java Jackson like More informations
  • Language choice
    • Java / Kotlin for Android
    • Objective C / Swift for iOS
  • Profiles / Environments
    • Dev
    • Prod
  • IntelliJ Config file for dev and prod profile

Entity generator

Generate your entity from your jhipster project

  • One by one
  • All your entities

More informations here

Prerequisites

As this is a JHipster module, we expect you have JHipster and its related tools already installed:

jhipster

Installation

With NPM

To install this blueprint:

npm install -g generator-jhipster-flutter-merlin

To update this blueprint:

npm update -g generator-jhipster-flutter-merlin

With Yarn

To install this blueprint:

yarn global add generator-jhipster-flutter-merlin

To update this blueprint:

yarn global upgrade generator-jhipster-flutter-merlin

Usage

To use this blueprint, run

yo jhipster-flutter-merlin

Running local module version for development

During development of module, please note the below steps. They are very important.

  1. Clone the projects

You'll probably need the current master of generator-jhipster :

  • fork generator-jhipster: https://github.com/jhipster/generator-jhipster/fork
  • clone locally your fork: git clone https://github.com/<your_username>/generator-jhipster
  • cd generator-jhipster
  • git remote add upstream https://github.com/jhipster/generator-jhipster
  • so you'll be able to update regularly your fork, using git fetch upstream && git checkout master && git rebase upstream/master
  • npm ci
  • npm link

Then, about jhipster-flutter :

  • fork jhipster-flutter: https://github.com/jhipster/jhipster-flutter/fork
  • clone locally your fork: git clone https://github.com/<your_username>/jhipster-flutter
  • cd jhipster-flutter
  • git remote add upstream https://github.com/jhipster/jhipster-flutter
  • so you'll be able to update regularly your fork, using git fetch upstream && git checkout master && git rebase upstream/master
  • npm ci
  • npm link
  • npm link generator-jhipster
  1. Create a new folder for the app to be generated and link JHipster and your blueprint there
mkdir my-app
cd my-app
npm link generator-jhipster-flutter-merlin
yo jhipster-flutter-merlin

Help and contribution to the project

Feel free to help, the project is open to PR

License

Apache-2.0 © Cyril Casaucau