/getx_sample

A new Flutter project base on GetX framework.

Primary LanguageDart

GetX_Sample

A Flutter project base on GetX.

Introduction

This project is a sample project building to adapt to a full software development life cycle including Tasks Estimation, Codebase Creation, Source Code Management using Git Flow, Testing(unit tests, integration tests), Continuous Integration, Continuous Delivery, and Continuous Deployment.

Installation

1. Install the Flutter SDK.

You can follow the steps from the Flutter official web page.

2. Active the Melos package.

You can install this package after the Flutter SDK installing with this command:

dart pub global activate melos

Or you can view the Melos package homepage for more details.

3. Install necessary tools.

After performing 2 steps above, you can install other necessary tools by running Melos's command following below:

Melos installTools

Note: You need to pay attention to the installation process to grant root permission for some necessary settings.

This Melos's script will install FVM for you too so you can skip the fourth step below. However, you still need to active FVM for this project following the below command:

Melos fvmUse

4. Install the Flutter Version Manager(FVM).

Flutter version management is a big trouble that any Flutter developers have to face in their development process. So, in this project, I have used the FVM(Flutter Version Management) package to manage it easily, rapidly, and conveniently.

To install this app, you can see at FVM official page. Here, I only show you some steps to run this sample.

  1. Flutter version 2.10.3 is used for this project:
fvm use 2.10.3
  1. FVM setup for the Android Studio:

  1. FVM setup for the VSCode: Create a settings.json file on ~/.vscode folder and paste content below:
{
  "dart.flutterSdkPath": ".fvm/flutter_sdk",
  // Remove .fvm files from search
  "search.exclude": {
    "**/.fvm": true
  },
  // Remove from file watching
  "files.watcherExclude": {
    "**/.fvm": true
  },
  "terminal.integrated.fontFamily": "MesloLGS NF",
}

Libraries Used

  • Third party
    • GetX fast, stable, extra-light and powerful Flutter framework.
    • Get_CLI is a CLI tool used to help build your App's features with GetX more easily.
    • Melos is a CLI tool used to help manage Dart projects with multiple modules/packages and more ….
    • Flutter_Gen: The Flutter code generator for your assets, fonts, colors, ….
    • Theme Tailor: The code generator and theming utility for supercharging Flutter ThemeExtension classes.


CI/CD results with Gitlab, Gitlab Runner, Docker,... on another project.

1. Flutter project overview.

Flutter Project Overview

2. Results ran on Virtual Box's Ubuntu Server.

Setup environment and restore cached files Setup environment & restore cached files. Distribute to Firebase and save cached files. Distribute to Firebase and save cached files.

Screenshots

  1. Coverage Overview.

Coverage Overview

  1. Unit Test overview for a controller.

Unit Test Detail for ViewModel

  1. Unit Test Detail for a controller.

Unit Test Detail for Repository


References


License

Copyright 2022 DanhDue ExOICTIF, danhdue@gmail.com

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.