Skip to content

Commit c7ae397

Browse files
authored
Merge branch 'main' into fix_wrong_title
2 parents f152194 + 4b56bf4 commit c7ae397

File tree

10 files changed

+74
-111
lines changed

10 files changed

+74
-111
lines changed

astro.config.mjs

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,25 @@ export default defineConfig({
5151
},
5252
{ label: 'Deployment', link: '/api-server/deployment' },
5353
],
54+
},
55+
{
56+
label: 'Web Dashboard',
57+
collapsed: true,
58+
items: [
59+
{ label: 'Introduction', link: '/web-dashboard/' },
60+
{ label: 'Local Setup', link: '/web-dashboard/local-setup' },
61+
{
62+
label: 'Features',
63+
collapsed: true,
64+
items: [
65+
{ label: 'App Configuration', link: '/web-dashboard/features/app-configuration' },
66+
{ label: 'Authentication', link: '/web-dashboard/features/authentication' },
67+
{ label: 'Content Management', link: '/web-dashboard/features/content-management' },
68+
{ label: 'Dashboard Overview', link: '/web-dashboard/features/dashboard-overview' },
69+
],
70+
},
71+
{ label: 'Deployment', link: '/web-dashboard/deployment' },
72+
],
5473
},
5574
{
5675
label: 'Mobile Client',
@@ -82,25 +101,6 @@ export default defineConfig({
82101
{ label: 'Deployment', link: '/mobile-client/deployment' },
83102
],
84103
},
85-
{
86-
label: 'Web Dashboard',
87-
collapsed: true,
88-
items: [
89-
{ label: 'Introduction', link: '/web-dashboard/' },
90-
{ label: 'Local Setup', link: '/web-dashboard/local-setup' },
91-
{
92-
label: 'Features',
93-
collapsed: true,
94-
items: [
95-
{ label: 'App Configuration', link: '/web-dashboard/features/app-configuration' },
96-
{ label: 'Authentication', link: '/web-dashboard/features/authentication' },
97-
{ label: 'Content Management', link: '/web-dashboard/features/content-management' },
98-
{ label: 'Dashboard Overview', link: '/web-dashboard/features/dashboard-overview' },
99-
],
100-
},
101-
{ label: 'Deployment', link: '/web-dashboard/deployment' },
102-
],
103-
},
104104
],
105105
}),
106106
],
123 KB
Loading

src/assets/houston.webp

-96.2 KB
Binary file not shown.

src/content/docs/api-server/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
77

88
The API Server is the core backend component of the Flutter News App Toolkit. Built with the high-performance [Dart Frog](https://dartfrog.vgv.dev/) framework, it provides all the necessary server-side features, including robust authentication, data management, and dynamic remote configuration.
99

10-
It is designed to work seamlessly with the [Mobile Client](/mobile-client/) and the [Web Dashboard](/web-dashboard/).
10+
It is designed to work seamlessly with the [Mobile Client](/docs/mobile-client/) and the [Web Dashboard](/docs/web-dashboard/).
1111

1212
<CardGrid>
1313
<Card title="Getting Started" icon="rocket">
1414
Follow the local setup guide to get the server running on your machine.
15-
[Read more &rarr;](/api-server/getting-started/)
15+
[Read more &rarr;](/docs/api-server/getting-started/)
1616
</Card>
1717
<Card title="Deployment" icon="cloud">
1818
Learn how to deploy the API server to a production environment.
19-
[Read more &rarr;](/api-server/deployment/)
19+
[Read more &rarr;](/docs/api-server/deployment/)
2020
</Card>
2121
<Card title="Features" icon="puzzle">
2222
Explore the key features and architecture of the API server.
23-
[Read more &rarr;](/api-server/features/authentication/)
23+
[Read more &rarr;](/docs/api-server/features/authentication/)
2424
</Card>
2525
</CardGrid>

src/content/docs/deployment-guides.mdx

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,26 @@ title: 'Deployment Guides: From Local to Live'
33
description: A collection of guides to help you deploy the API server, mobile app, and web dashboard to production environments.
44
---
55

6-
import { Card, CardGrid } from '@astrojs/starlight/components';
6+
import { Steps } from '@astrojs/starlight/components';
77

88
Once you have the ecosystem running locally, the next step is to deploy the components to production. These guides provide step-by-step instructions for preparing and deploying each part of the toolkit.
99

10-
<CardGrid>
11-
<Card title="1. Deploy the API Server" icon="cloud">
10+
<Steps>
11+
1. **Deploy the API Server**
12+
1213
Learn how to configure and deploy the Dart Frog backend to a production server using Docker.
13-
<a href="/api-server/deployment/" style={{ display: 'block', marginTop: '1rem' }}>
14-
Go to API Deployment Guide &rarr;
15-
</a>
16-
</Card>
17-
<Card title="2. Deploy the Web Dashboard" icon="laptop">
14+
15+
[Go to API Deployment Guide &rarr;](/docs/api-server/deployment/)
16+
17+
2. **Deploy the Web Dashboard**
18+
1819
Follow these steps to build and deploy the Flutter web dashboard to a static hosting provider.
19-
<a href="/web-dashboard/deployment/" style={{ display: 'block', marginTop: '1rem' }}>
20-
Go to Dashboard Deployment Guide &rarr;
21-
</a>
22-
</Card>
23-
<Card title="3. Deploy the Mobile Client" icon="phone">
20+
21+
[Go to Dashboard Deployment Guide &rarr;](/docs/web-dashboard/deployment/)
22+
23+
3. **Deploy the Mobile Client**
24+
2425
Prepare and build your Flutter mobile app for release on the Apple App Store and Google Play Store.
25-
<a href="/mobile-client/deployment/" style={{ display: 'block', marginTop: '1rem' }}>
26-
Go to Mobile App Deployment Guide &rarr;
27-
</a>
28-
</Card>
29-
</CardGrid>
26+
27+
[Go to Mobile App Deployment Guide &rarr;](/docs/mobile-client/deployment/)
28+
</Steps>

src/content/docs/getting-started.mdx

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,28 @@ title: 'Getting Started: Local Setup'
33
description: An overview of the local setup process for the entire Flutter News App ecosystem.
44
---
55

6-
import { Card, CardGrid } from '@astrojs/starlight/components';
6+
import { Steps } from '@astrojs/starlight/components';
77

88
Welcome to the local setup guide for the Flutter News App Toolkit. To get the full ecosystem running on your local machine, you will need to set up each of the three core components: the **API Server**, the **Web Dashboard**, and the **Mobile Client**.
99

1010
Follow the guides below in the recommended order to ensure a smooth setup process.
1111

12-
<CardGrid>
13-
<Card title="1. Set Up the API Server" icon="cloud">
12+
<Steps>
13+
1. **Set Up the API Server**
14+
1415
Start by getting the backend running. The API server handles data, authentication, and configuration for both the dashboard and the mobile app.
15-
<a href="/api-server/local-setup/" style={{ display: 'block', marginTop: '1rem' }}>
16-
Go to API Setup Guide &rarr;
17-
</a>
18-
</Card>
19-
<Card title="2. Set Up the Web Dashboard" icon="laptop">
16+
17+
[Go to API Setup Guide &rarr;](/docs/api-server/local-setup/)
18+
19+
2. **Set Up the Web Dashboard**
20+
2021
Next, run the web-based administrative dashboard. You'll use this to manage content and configure the application.
21-
<a href="/web-dashboard/local-setup/" style={{ display: 'block', marginTop: '1rem' }}>
22-
Go to Dashboard Setup Guide &rarr;
23-
</a>
24-
</Card>
25-
<Card title="3. Set Up the Mobile Client" icon="phone">
22+
23+
[Go to Dashboard Setup Guide &rarr;](/docs/web-dashboard/local-setup/)
24+
25+
3. **Set Up the Mobile Client**
26+
2627
Finally, set up the Flutter mobile app for iOS and Android to see the end-user experience.
27-
<a href="/mobile-client/local-setup/" style={{ display: 'block', marginTop: '1rem' }}>
28-
Go to Mobile App Setup Guide &rarr;
29-
</a>
30-
</Card>
31-
</CardGrid>
28+
29+
[Go to Mobile App Setup Guide &rarr;](/docs/mobile-client/local-setup/)
30+
</Steps>

src/content/docs/index.mdx

Lines changed: 14 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ template: splash
55
hero:
66
tagline: Includes a Flutter mobile app, a web-based dashboard, and a powerful Dart Frog backend.
77
image:
8-
file: ../../assets/houston.webp
8+
file: ../../assets/flutter-news-app-full-source-code-logo.png
99
actions:
1010
- text: 'Get Started: Local Setup'
1111
link: /docs/getting-started/
@@ -24,27 +24,10 @@ import { Card, CardGrid, LinkButton } from '@astrojs/starlight/components';
2424

2525
Welcome to the Flutter News App Full Source Code Toolkit. This is more than just an app template; it's a complete, three-part ecosystem designed to work seamlessly together, giving you everything you need to launch, manage, and scale a modern news application.
2626

27-
<div
28-
style={{
29-
display: 'grid',
30-
gridTemplateColumns: 'repeat(auto-fit, minmax(250px, 1fr))',
31-
gap: '1rem',
32-
alignItems: 'stretch',
33-
}}
34-
>
35-
<Card
36-
title="Mobile Client App"
37-
icon="phone"
38-
style={{
39-
display: 'flex',
40-
flexDirection: 'column',
41-
justifyContent: 'space-between',
42-
}}
43-
>
44-
<div>
45-
A feature-rich Flutter application for iOS and Android that delivers a
46-
beautiful, intuitive news reading experience to your users.
47-
</div>
27+
<CardGrid>
28+
<Card title="Mobile Client App" icon="phone">
29+
A feature-rich Flutter application for iOS and Android that delivers a
30+
beautiful, intuitive news reading experience to your users.
4831
<div
4932
style={{
5033
display: 'flex',
@@ -67,19 +50,9 @@ Welcome to the Flutter News App Full Source Code Toolkit. This is more than just
6750
</a>
6851
</div>
6952
</Card>
70-
<Card
71-
title="Web Dashboard"
72-
icon="laptop"
73-
style={{
74-
display: 'flex',
75-
flexDirection: 'column',
76-
justifyContent: 'space-between',
77-
}}
78-
>
79-
<div>
80-
A comprehensive Flutter web app for administrators and publishers to manage
81-
content, configure app settings, and view key analytics.
82-
</div>
53+
<Card title="Web Dashboard" icon="laptop">
54+
A comprehensive Flutter web app for administrators and publishers to manage
55+
content, configure app settings, and view key analytics.
8356
<div
8457
style={{
8558
display: 'flex',
@@ -102,19 +75,11 @@ Welcome to the Flutter News App Full Source Code Toolkit. This is more than just
10275
</a>
10376
</div>
10477
</Card>
105-
<Card
106-
title="API Server"
107-
icon="cloud"
108-
style={{
109-
display: 'flex',
110-
flexDirection: 'column',
111-
justifyContent: 'space-between',
112-
}}
113-
>
114-
<div>
115-
A high-performance backend built with Dart Frog, providing robust APIs for
116-
authentication, data management, and remote configuration.
117-
</div>
78+
</CardGrid>
79+
<div style={{ marginTop: '1rem' }}>
80+
<Card title="API Server" icon="cloud">
81+
A high-performance backend built with Dart Frog, providing robust APIs for
82+
authentication, data management, and remote configuration.
11883
<div
11984
style={{
12085
display: 'flex',
@@ -153,7 +118,7 @@ Welcome to the Flutter News App Full Source Code Toolkit. This is more than just
153118
href="https://github.com/sponsors/flutter-news-app-full-source-code"
154119
target="_blank"
155120
>
156-
Purchase License - $248
121+
Purchase License
157122
</LinkButton>
158123
</div>
159124
</Card>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This guide covers the essential steps for deploying the Flutter News App Web Das
2222
```
2323

2424
<Aside>
25-
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](./api-server/deployment/).
25+
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/).
2626
</Aside>
2727

2828
2. **Build the Web Application**

src/content/docs/web-dashboard/local-setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ This guide will walk you through setting up and running the Flutter News App Web
5050
```
5151

5252
<Aside>
53-
For the `development` environment, you must have the [API Server running locally](./getting-started/local-setup-api) first.
53+
For the `development` environment, you must have the [API Server running locally](/docs/getting-started/local-setup-api) first.
5454
</Aside>
5555

5656
5. **Run the Development Server**

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This guide covers the essential steps for deploying the Flutter News App Web Das
2222
```
2323

2424
<Aside>
25-
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](./deployment/api-server/).
25+
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/deployment/api-server/).
2626
</Aside>
2727

2828
2. **Build the Web Application**

0 commit comments

Comments
 (0)