|
| 1 | +--- |
| 2 | +title: 'Getting Started' |
| 3 | +description: A step-by-step guide to evaluating, running, and customizing the Flutter News App Toolkit. |
| 4 | +--- |
| 5 | +import { Card, CardGrid } from '@astrojs/starlight/components'; |
| 6 | + |
| 7 | +Welcome to the Flutter News App Toolkit! This section provides a recommended path for all new users to ensure a smooth and successful experience. |
| 8 | + |
| 9 | +Whether you are evaluating the toolkit under the free trial license or are ready to build your production application, we suggest following these guides in the order they are presented. |
| 10 | + |
| 11 | +<CardGrid> |
| 12 | + <Card title="1. Understand the Core Philosophy" icon="open-book"> |
| 13 | + Begin by learning about the production-ready principles that guided the toolkit's construction. This will help you understand the value and quality of the architecture. |
| 14 | + [Read the Core Philosophy →](/docs/getting-started/core-philosophy/) |
| 15 | + </Card> |
| 16 | + <Card title="2. Understand the Toolkit Architecture" icon="file-tree"> |
| 17 | + Next, get a high-level overview of the multi-repository structure. Understanding how the applications and shared packages work together is essential for effective customization. |
| 18 | + [Learn about the Architecture →](/docs/getting-started/toolkit-architecture/) |
| 19 | + </Card> |
| 20 | + <Card title="3. Run the Toolkit Locally" icon="laptop"> |
| 21 | + Follow our comprehensive setup guides to get the API Server, Web Dashboard, and Mobile Client running on your local machine. |
| 22 | + [Go to Local Setup →](/docs/getting-started/local-setup/) |
| 23 | + </Card> |
| 24 | + <Card title="4. Learn to Customize" icon="puzzle"> |
| 25 | + Once you have the toolkit running, you'll want to learn how to modify it. This section covers the critical workflow for taking ownership of shared packages. |
| 26 | + [View Customization Guides →](/docs/customization/) |
| 27 | + </Card> |
| 28 | + <Card title="5. Deploy to Production" icon="rocket"> |
| 29 | + When you're ready to go live, these guides will walk you through deploying each component of the toolkit to a production environment. |
| 30 | + [View Deployment Guides →](/docs/getting-started/deployment/) |
| 31 | + </Card> |
| 32 | +</CardGrid> |
0 commit comments