mirror of
https://github.com/lichess-org/mobile.git
synced 2026-05-26 13:50:52 +00:00
Add setup and run instruction in the readme
This commit is contained in:
@@ -8,10 +8,40 @@ Contributions to this project are welcome!
|
||||
|
||||
If you want to contribute, please read the [contributing guide](./CONTRIBUTING.md).
|
||||
|
||||
## Setup and Run
|
||||
## 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](./docs/setting_dev_env.md) for detailed instructions.
|
||||
|
||||
## Running the app
|
||||
|
||||
To run the app, you can use the following command:
|
||||
|
||||
```bash
|
||||
# if not already done, run the code generation
|
||||
dart run build_runner build
|
||||
|
||||
# run the app on all available devices
|
||||
flutter run -d all
|
||||
```
|
||||
|
||||
## Running tests
|
||||
|
||||
To run the tests, you can use the following command:
|
||||
|
||||
```bash
|
||||
# if not already done, run the code generation
|
||||
dart run build_runner build
|
||||
|
||||
flutter test
|
||||
```
|
||||
|
||||
## Internationalisation
|
||||
|
||||
Do not edit the `app_en.arb` file by hand, this file is generated.
|
||||
|
||||
Reference in New Issue
Block a user