Skip to content

Latest commit

 

History

History
167 lines (106 loc) · 4.15 KB

README.md

File metadata and controls

167 lines (106 loc) · 4.15 KB
Raw

Titan

Titan is a cross platform frontend written in Flutter for an open-source project launched by ÉCLAIR, the computer science association of Ecole Centrale de Lyon. This project aims to provide students of business and engineering schools a digital tool to simplify the association process.

Our builds of Titan are called MyECL and can be downloaded from the App Store and from the Google Play Store.

Setup environment

Install Flutter: https://docs.flutter.dev/get-started/install

Setup VS Code for Flutter development: https://docs.flutter.dev/get-started/editor?tab=vscode

Titan is designed to be launched on Web, Android and iOS platforms.

Configure Titan

Update .env to match your Hyperion's backend:

PROD_HOST = "<<Your Production Server Host>>

You can also specify an other host for debuging:

DEV_HOST = "<<Your Debbuging Server Host>>

NB: a trailing slash is required.

Development

Formatting

To format code use dart format .

dart format .

Linting

Titan support linting according to the official Flutter static analysis options.

The linter can be launched using:

dart analyze

Dart allows you to fix issues in your code with the dart command dart fix.

To preview proposed changes, use the --dry-run flag:

dart fix --dry-run

To apply the proposed changes, use the --apply flag:

dart fix --apply

Testing

Titan's tests follow the official Flutter documentation.

Tests can be run using:

flutter test --flavor dev

To run a specific test file :

flutter test --flavor dev path/to/file.dart

Flavors

Titan supports flavors, which allows to easily switch between several versions of Titan for several use cases.

Titan includes 3 flavors: dev, alpha, prod. On VSCode, you can choose which flavor to use when launching the debugger

Each flavor is associated with a specific app package name (fr.myecl.titan.dev, fr.myecl.titan.alpha, fr.myecl.titan) allowing the three app to be installed on the same device. Each flavor use its own Hyperion url defined in the dotenv

Build with a flavor

To build Titan with a specific flavor use:

flutter build {target} --flavor={flavor}

Currently flavor are not supported for Flutter for web, you should use:

flutter build web --dart-define=flavor={flavor}

Notifications setup

Notifications are handled using the Firebase Cloud Messaging API. On mobile platforms, a valid notification configuration is required to debug Titan. Notifications are disabled on web builds.

Please refer to the documentation of the corresponding Flutter's package to correctly setup notifications.

Please follow Android or iOS Firebase documentation to setup notifications.

Android FCM config file

For Android, add your google-services.json in android/app/src/<flavor>/.

iOS FCM config file

For iOS, add your GoogleService-Info.plist in ios/config/<flavor/.

Advanced

Allows non SSL connexion to use a custom local Hyperion backend

On mobile, using plaintext HTTP connexions may raise issues.

Android

Update AndroidManifest.xml:

<application
    ...
    android:usesCleartextTraffic="true"
    ...   >

iOS

Update Info.plist:

<key>CADisableMinimumFrameDurationOnPhone</key>
<true/>
<key>NSAppTransportSecurity</key>
<dict>
	<key>NSAllowsArbitraryLoads</key>
	<true/>
	<key>NSExceptionDomains</key>
	<dict>
		<key>yourdomain.com</key>
		<dict>
			<key>NSIncludesSubdomains</key>
			<true/>
			<key>NSThirdPartyExceptionRequiresForwardSecrecy</key>
			<false/>
		</dict>
	</dict>
</dict>

Update Titan's icon

First update the icon's file and update pubspec.yaml.

Then, flutter_launcher_icons must be updated:

flutter pub get
flutter pub run flutter_launcher_icons