Skip to content

Commit c1f570b

Browse files
committed
docs(mobile-client): add app icon and splash screen configuration
- Add steps for configuring app icons using flutter_launcher_icons - Add steps for configuring native splash screens using flutter_native_splash - Update existing content for improved readability
1 parent c58c1fa commit c1f570b

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

src/content/docs/mobile-client/deployment.mdx

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ To ensure you have the most reliable and up-to-date instructions, this guide foc
1111
</Aside>
1212

1313
### Pre-Deployment Configuration
14-
1514
Before you can build the app for production, you must configure it to connect to your live API server.
1615

1716
<Steps>
@@ -31,6 +30,35 @@ Before you can build the app for production, you must configure it to connect to
3130
- Open the file `lib/app/config/app_config.dart`.
3231
- Ensure that the `baseUrl` for the `production` case points to the correct URL of your deployed [API Server](/docs/api-server/deployment/).
3332

33+
3. **Configure App Icons**
34+
35+
The project uses `flutter_launcher_icons` to generate app icons. You will need to update the configuration in `pubspec.yaml` to use your own icon assets.
36+
37+
- Open `pubspec.yaml`.
38+
- Locate the `flutter_launcher_icons` section.
39+
- Update the `image_path` to point to your desired icon image.
40+
- After updating, run the following command to generate the new icons:
41+
```bash
42+
flutter pub run flutter_launcher_icons:main
43+
```
44+
<Aside type="tip">
45+
For more details, refer to the [flutter_launcher_icons documentation](https://pub.dev/packages/flutter_launcher_icons).
46+
</Aside>
47+
48+
4. **Configure Native Splash Screen**
49+
50+
The project uses `flutter_native_splash` for native splash screens. You will need to update the configuration in `pubspec.yaml` to use your own splash screen assets and colors.
51+
52+
- Open `pubspec.yaml`.
53+
- Locate the `flutter_native_splash` section.
54+
- Update `color`, `color_dark`, `image`, and `image_dark` to match your branding.
55+
- After updating, run the following command to generate the new splash screens:
56+
```bash
57+
flutter pub run flutter_native_splash:create
58+
```
59+
<Aside type="tip">
60+
For more details, refer to the [flutter_native_splash documentation](https://pub.dev/packages/flutter_native_splash).
61+
</Aside>
3462
</Steps>
3563

3664
### Building and Releasing

0 commit comments

Comments
 (0)