flutter-client

Flutter CLI

A CLI for Flutter projects.

Getting Started

This CLI is made for avoid typing some of the most used commands and configurations for building, generation and creation of flutter apps.

Install CLI (WIP)

$ npm install -g flutter-client

Current way to use flutter-client

• Download repository
• Enter repository folder using terminal and run

$ npm install
$ npm link

Running CLI

$ flutter-client

Features

• Build app depending on platform, environment or android build types

WIP

• Test app
• New project
• New app
• New library

Environments

• Production - Used to show the app to the world
• QA - Used to show the app to the client
• Staging - Used for development purposes

Platforms

• Android
• iOS

Android generation

• Apk (.apk)
• Bundle (.aab)

Default configuration for CLI

By default, flutter-client comes with this configuration

module.exports = {
    defaults: {
        mainFileStagingPath: 'lib/main_staging.dart',
        mainFileQAPath: 'lib/main_qa.dart',
        mainFileProductionPath: 'lib/main.dart',
        bundlePath: 'build/app/outputs/bundle/release/',
        apkPath: 'build/app/outputs/apk/release/',
    },
}

Custom configuration for CLI

You can use flutter-client to initialise configuration automatically or you can create a flutter-client.config.js file on root of your project with the following template in order to overwrite configuration:

module.exports = {
    defaults: {
        mainFileStagingPath: 'PATH_TO_FILE',
        mainFileQAPath: 'PATH_TO_FILE',
        mainFileProductionPath: 'PATH_TO_FILE',
        bundlePath: 'PATH_TO_GENERATED_BUNDLE',
        apkPath: 'PATH_TO_GENERATED_APK',
    },
}

Authors

• Albert Parrón

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details