BrightUI

BrightUI is a Flutter module that contains UI elements/widgets that all of our Flutter apps use.

How to add BrightServices to existing Flutter app:

1. Add flutter_bright_ui as a submodule to your project by running the following command in the root of your project:

	git submodule add git@github.com:brighthr/flutter_bright_ui.git

2. Update your project's .gitmodules file to relative path to submodule:

[submodule "flutter_bright_ui"]
	path = flutter_bright_ui
	url = ../flutter_bright_ui.git

3. Pull the submodule into your project:

git submodule update --remote

4. In order to pull a specific branch or tag you need to navigate to the submodule and fetch it manually.

In this example we are pulling a tag of version 1.2.0:

# Navigate to submodule directory within your project
cd flutter_bright_ui
git fetch
git checkout 1.2.0
git pull
flutter pub get

Useful information on working with submodules can be found here: https://devconnected.com/how-to-add-and-update-git-submodules/

5. Update pubspec.yml in your project to include a reference:

...
dependencies:
  flutter:
    sdk: flutter
...
  flutter_bright_ui:
    path: ./flutter_bright_ui
...

Pipelines:

We have one pipeline names tests.yaml that runs unit tests and uploads a code coverage report to CodeCov