Skip to content

Commit 904ce15

Browse files
committed
docs(web-dashboard): refine deployment guide
- Clarify the guide's focus on pre-deployment configuration - Expand on the production environment setup - Improve structure with subheadings for better readability - Emphasize the official Flutter guide as the authoritative resource
1 parent c9d6eba commit 904ce15

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

src/content/docs/web-dashboard/deployment.mdx

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,18 @@ description: A guide to building and deploying the Flutter web dashboard to a pr
55

66
import { Steps, Aside } from '@astrojs/starlight/components';
77

8-
This guide outlines the process for deploying the Flutter News App Web Dashboard.
8+
This guide outlines the process for deploying the Flutter News App Web Dashboard to a production environment.
99

1010
<Aside>
11-
To ensure you have the most reliable and up-to-date instructions, this guide will direct you to the official Flutter documentation. The process of building and deploying a Flutter web app is well-documented by the Flutter team, and their guide is the definitive resource for this task.
11+
To ensure you have the most reliable and up-to-date instructions, this guide focuses on the project-specific configuration you need to complete. For the deployment itself, we will refer you to the official Flutter documentation, which is the definitive resource for this task.
1212
</Aside>
1313

14-
<Steps>
15-
1. **Configure for Production**
14+
### Pre-Deployment Configuration
15+
16+
Before you can build the dashboard for production, you must configure it to connect to your live API server.
1617

17-
Before building, you must configure the dashboard to connect to your live production API.
18+
<Steps>
19+
1. **Set the Production Environment**
1820

1921
- Open the file `lib/main.dart`.
2022
- Locate the `appEnvironment` constant.
@@ -25,17 +27,17 @@ To ensure you have the most reliable and up-to-date instructions, this guide wil
2527
const appEnvironment = AppEnvironment.production;
2628
```
2729

28-
<Aside>
29-
Ensure that the `baseUrl` for the `production` environment in `lib/app/config/app_config.dart` points to the correct URL of your deployed [API Server](/docs/api-server/deployment/).
30-
</Aside>
30+
2. **Verify the API Base URL**
3131

32-
2. **Follow the Official Flutter Deployment Guide**
32+
- Open the file `lib/app/config/app_config.dart`.
33+
- Ensure that the `baseUrl` for the `production` case points to the correct URL of your deployed [API Server](/docs/api-server/deployment/).
3334

34-
The Flutter team provides a comprehensive guide that covers everything you need to know about building and deploying a Flutter web application. This includes compiling your Dart code to JavaScript and deploying the output to various hosting services.
35+
</Steps>
3536

36-
Please follow the official guide here:
37-
**[Build and release a web app](https://flutter.dev/docs/deployment/web)**
37+
### Building and Deploying
3838

39-
This guide will walk you through the `flutter build web` command and provide best practices for hosting the contents of the generated `build/web` directory.
39+
Once your configuration is ready, you can proceed with building and deploying the application. The official Flutter documentation provides a comprehensive guide that covers compiling your Dart code to JavaScript and deploying the output to various hosting services.
4040

41-
</Steps>
41+
Following the official guide is the recommended and most reliable path to a successful deployment.
42+
43+
**[Official Guide: Build and release a web app](https://flutter.dev/docs/deployment/web)**

0 commit comments

Comments
 (0)