Skip to content

Commit 9aa644f

Browse files
committed
docs(web-dashboard): update deployment guide with enhanced clarity and resource links
- Add an Aside to explain the guide's focus on core deployment process - Improve language consistency and clarity - Remove specific deployment instructions in favor of official documentation links - Introduce list of recommended hosting providers with their deployment guides
1 parent 4c539ce commit 9aa644f

File tree

1 file changed

+13
-33
lines changed

1 file changed

+13
-33
lines changed

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

Lines changed: 13 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ import { Steps, Aside } from '@astrojs/starlight/components';
77

88
This guide covers the essential steps for deploying the Flutter News App Web Dashboard to a production hosting service.
99

10+
<Aside>
11+
The world of web hosting evolves quickly. To ensure you have the most reliable and up-to-date instructions, this guide focuses on the core deployment process and links to the official documentation for several popular hosting providers. This approach empowers you to use the best practices recommended directly by the services themselves.
12+
</Aside>
13+
1014
<Steps>
1115
1. **Configure for Production**
1216

@@ -27,48 +31,24 @@ This guide covers the essential steps for deploying the Flutter News App Web Das
2731

2832
2. **Build the Web Application**
2933

30-
Next, create a production-optimized build of the Flutter web app. This compiles the Dart code to JavaScript and bundles all necessary assets for web deployment.
34+
Next, create a production-optimized build of the Flutter web app. This compiles your Dart code to JavaScript and bundles all necessary assets into a single directory for web deployment.
3135

3236
Run the following command from the root of your web dashboard project:
3337
```bash
3438
flutter build web
3539
```
36-
This will generate a `build/web` directory containing all the static files for your web application.
37-
38-
3. **Choose a Hosting Provider**
39-
40-
You can deploy the contents of the `build/web` directory to any hosting service that supports static websites. Popular and easy-to-use choices include:
40+
This command will generate a `build/web` directory containing all the static files required to run your web application.
4141

42-
- [Firebase Hosting](https://firebase.google.com/docs/hosting)
43-
- [Vercel](https://vercel.com/)
44-
- [Netlify](https://www.netlify.com/for/web-applications/)
45-
- [GitHub Pages](https://docs.github.com/en/pages)
42+
3. **Deploy to a Hosting Provider**
4643

47-
4. **Deploy the Application**
44+
The contents of the `build/web` directory can be deployed to any hosting service that supports static websites. We recommend choosing a provider with a strong global CDN to ensure fast load times for your users.
4845

49-
Follow the deployment instructions for your chosen hosting provider. The general process involves:
46+
Follow the official deployment guide for your chosen provider, using `build/web` as your publish directory:
5047

51-
- Initializing the hosting service in your project directory.
52-
- Specifying the `build/web` directory as the public or publish directory.
53-
- Running the provider's deploy command from your terminal.
54-
55-
For example, if you were using Firebase Hosting, the commands would look something like this:
56-
57-
```bash
58-
# Install Firebase CLI (if you haven't already)
59-
npm install -g firebase-tools
60-
61-
# Log in to Firebase
62-
firebase login
63-
64-
# Initialize Firebase in your project
65-
firebase init hosting
66-
67-
# When prompted, set the public directory to "build/web"
68-
69-
# Deploy to Firebase Hosting
70-
firebase deploy
71-
```
48+
- **Firebase Hosting:** [Official Deployment Guide](https://firebase.google.com/docs/hosting/quickstart)
49+
- **Vercel:** [Official Deployment Guide for Flutter](https://vercel.com/guides/deploying-flutter-to-vercel)
50+
- **Netlify:** [Official Deployment Guide](https://docs.netlify.com/site-deploys/create-deploys/)
51+
- **GitHub Pages:** [Official Deployment Guide](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)
7252

7353
Once the deployment is complete, your web dashboard will be live at the URL provided by your hosting service.
7454

0 commit comments

Comments
 (0)