Skip to content

Commit f7465d6

Browse files
committed
docs(mobile-client): add introduction documentation
- Overview of the Flutter News App Mobile Client - Core technologies used (Flutter, Bloc, go_router) - Key features highlighted with card grid - Getting started guide link included
1 parent a2578b3 commit f7465d6

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Introduction
3+
description: An overview of the Flutter News App Mobile Client.
4+
---
5+
6+
import { Card, CardGrid } from '@astrojs/starlight/components';
7+
8+
Welcome to the documentation for the Flutter News App Mobile Client, a key component of the Flutter News App Toolkit. This application is a feature-rich, cross-platform mobile app built with Flutter, designed to deliver a seamless and engaging news consumption experience to your users on both iOS and Android.
9+
10+
## Core Technologies
11+
12+
The mobile client is built on a modern, scalable, and maintainable tech stack, ensuring a high-quality foundation for your product.
13+
14+
- **Framework**: [Flutter](https://flutter.dev/) for building beautiful, natively compiled applications for mobile from a single codebase.
15+
- **State Management**: [Bloc](https://bloclibrary.dev/) for predictable and testable state management, separating business logic from the UI.
16+
- **Routing**: [go_router](https://pub.dev/packages/go_router) for a declarative, URL-based navigation system that is robust and easy to manage.
17+
- **Architecture**: Follows the layered architecture principles outlined in the Core Philosophy, ensuring a clean separation of concerns between the UI, business logic, and data layers.
18+
19+
## Key Features
20+
21+
The mobile client comes packed with features designed to provide a comprehensive user experience.
22+
23+
<CardGrid>
24+
<Card title="Dynamic Headlines Feed" icon="newspaper">
25+
A customizable news feed that supports pagination, pull-to-refresh, and dynamic content injection for ads and user engagement prompts.
26+
</Card>
27+
<Card title="Advanced Search" icon="search">
28+
Users can search for headlines, topics, or sources, with results displayed in a clear and intuitive interface.
29+
</Card>
30+
<Card title="User Personalization" icon="user">
31+
Authenticated users can personalize their experience by following topics and sources, and saving articles to read later.
32+
</Card>
33+
<Card title="Comprehensive Settings" icon="settings">
34+
A detailed settings module allows users to customize the app's appearance, theme, font size, language, and feed display preferences.
35+
</Card>
36+
</CardGrid>
37+
38+
## Getting Started
39+
40+
To get the mobile client up and running on your local machine, head over to our setup guide.
41+
42+
- **[Local Setup Guide](./getting-started/local-setup)**

0 commit comments

Comments
 (0)