Lichess Mobile

Second iteration of the Lichess mobile app.

How to contribute

Contributions to this project are welcome!

If you want to contribute, please read the contributing guide.

If you are new to this project, you can read the documentation to get started. The AGENTS.md is also a good resource to understand the codebase.

Setup

tl;dr: Install Flutter, clone the repo, run in order:

• flutter pub get
• dart run build_runner watch
• flutter analyze --watch

and you're ready to code!

See the dev environment docs for detailed instructions.

Running the app

To run the app, you can use the following command:

# if not already done, run the code generation
dart run build_runner build

# run the app on all available devices
flutter run -d all

Previewing the platform designs

To check the iOS and Android designs on any device, run the app in device preview:

flutter run -t lib/device_preview_main.dart

See Device preview for how to use it and its limitations.

Running tests

To run the tests, you can use the following command:

# if not already done, run the code generation
dart run build_runner build

flutter test

Internationalisation

Do not edit the files in translation/ folder (except translation/source/mobile.xml), nor the app_en.arb file: these files are generated. For more information, see Internationalisation.

Releasing

Only for members of lichess team.

1. Bump the pubspec.yaml version number. This can be in a PR making a change or a separate PR. Use semantic versioning to determine which part to increment. The version number after the + should also be incremented. For example 0.3.3+000303 with a patch should become 0.3.4+000304.
2. Run workflow Deploy to Play Store
3. Publish on F-Droid