Skip to content

Commit d7062c2

Browse files
committed
docs(README): update content and clarify getting started instructions
- Rename repository in README title - Enhance feature descriptions and benefits - Improve licensing explanation - Expand and clarify getting started instructions - Add section on running the app in different environments - Remove duplicate test command at the end
1 parent f5a77b9 commit d7062c2

File tree

1 file changed

+39
-24
lines changed

1 file changed

+39
-24
lines changed

README.md

Lines changed: 39 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,76 @@
1-
# 📱✨ flutter_news_app_mobile_client_full_source_code
1+
# The Complete Flutter News App - Full Source Code
22

33
![coverage: percentage](https://img.shields.io/badge/coverage-XX-green)
44
[![Demo: Live](https://img.shields.io/badge/Demo-Live-orange)](https://flutter-news-app-full-source-code.github.io/flutter-news-app-mobile-client-full-source-code/)
55
[![style: very good analysis](https://img.shields.io/badge/style-very_good_analysis-B22C89.svg)](https://pub.dev/packages/very_good_analysis)
66
[![License: PolyForm Free Trial](https://img.shields.io/badge/License-PolyForm%20Free%20Trial-blue)](https://polyformproject.org/licenses/free-trial/1.0.0)
77

8-
Flutter mobile application that serves as both a powerful, fully functional news application ready for deployment, and an exceptionally robust starter kit, architected for easy extension and customization. It is a key component of the [**Flutter News App - Full Source Code Toolkit**](https://github.com/flutter-news-app-full-source-code), an ecosystem that also includes a [Dart Frog backend API](https://github.com/flutter-news-app-full-source-code/flutter-news-app-api-server-full-source-code) and a [web-based content dashboard](https://github.com/flutter-news-app-full-source-code/flutter-news-app-web-dashboard-full-source-code).
8+
This is a complete and fully-functional Flutter news application. It gives you everything you need to launch your own news app on the App Store and Google Play, right out of the box. It is a key component of the [**Flutter News App - Full Source Code Toolkit**](https://github.com/flutter-news-app-full-source-code), an ecosystem that also includes a [Dart Frog backend API](https://github.com/flutter-news-app-full-source-code/flutter-news-app-api-server-full-source-code) and a [web-based content dashboard](https://github.com/flutter-news-app-full-source-code/flutter-news-app-web-dashboard-full-source-code).
99

10-
## Features & Benefits
10+
## Everything You Get, Ready to Go
1111

12-
`flutter_news_app_mobile_client_full_source_code` comes packed with features to accelerate your development and delight your users:
12+
This app comes packed with all the features you need to launch a professional news application.
1313

1414
#### 📰 **Dynamic & Engaging Headlines Feed**
15-
Experience a beautifully crafted, infinitely scrolling news feed. It's highly performant and ready for your content.
16-
* **Benefit for you:** Save months of UI/UX development and complex state management. Get a production-quality feed system instantly! ⏱️
15+
* Display news in a beautiful, performant, infinitely scrolling feed.
16+
* Engage users with a polished and modern UI right out of the box.
17+
> **Your Advantage:** You get a production-quality feed system instantly. Skip the months of complex UI work and state management. ⏱️
1718
1819
#### 🔍 **Advanced Content Filtering & Search**
19-
Empower users with intuitive filtering for headlines by categories, sources, and countries. A dedicated search page helps users find exactly what they're looking for.
20-
* **Benefit for you:** Offer powerful content discovery tools that significantly enhance user engagement and satisfaction. 🎯
20+
* Let users filter headlines by categories, sources, and countries.
21+
* Includes a dedicated search page to help users find specific content quickly.
22+
> **Your Advantage:** Give your users powerful content discovery tools that keep them engaged and coming back for more. 🎯
2123
2224
#### 🔐 **Robust User Authentication**
2325
Secure and flexible authentication flows are built-in:
2426
* 📧 **Email + Code (Passwordless) Sign-In:** Modern and secure.
2527
* 👤 **Anonymous Sign-In:** Allow users to explore before committing.
2628
* 🔗 **Account Linking:** Seamlessly convert anonymous users to registered accounts, preserving all their personalized settings, content preferences, and saved headlines.
27-
* **Benefit for you:** Complex security and user management handled, including data migration during account linking, letting you focus on features. ✅
29+
> **Your Advantage:** All the complex security and user management is already done for you, including data migration when users link their accounts. ✅
2830
2931
#### 🧑‍🎨 **Personalized User Accounts & Preferences**
3032
Users can tailor their experience:
3133
* **Content Preferences:** Follow/unfollow categories, sources, and countries.
3234
* **Saved Headlines:** Bookmark articles for easy access later.
33-
* **Benefit for you:** A strong foundation for personalization, driving user retention and creating a sticky app experience. ❤️
35+
> **Your Advantage:** Built-in personalization features that drive user retention and create a sticky app experience. ❤️
3436
3537
#### ⚙️ **Customizable App Settings**
3638
Offer users control over their app experience:
3739
* **Appearance:** Light/Dark/System themes, accent colors (via FlexColorScheme), font choices, and text scaling.
3840
* **Feed Display:** Customize how headlines are presented.
39-
* **Benefit for you:** Provide a premium, adaptable user experience that caters to individual needs. 🔧
41+
> **Your Advantage:** Deliver a premium, adaptable user experience that caters to individual needs without writing any code. 🔧
4042
4143
#### 📱 **Adaptive UI for All Screens**
42-
Built with `flutter_adaptive_scaffold`, `flutter_news_app_mobile_client_full_source_code` offers responsive navigation and layouts that look great on both phones and tablets.
43-
* **Benefit for you:** Deliver a consistent and optimized UX across a wide range of devices effortlessly. ↔️
44+
Built with `flutter_adaptive_scaffold`, the app offers responsive navigation and layouts that look great on both phones and tablets.
45+
> **Your Advantage:** Deliver a consistent and optimized UX across a wide range of devices effortlessly. ↔️
4446
4547
#### 🏗️ **Clean & Modern Architecture**
4648
Developed with best practices for a maintainable and scalable codebase:
4749
* **Flutter & Dart:** Cutting-edge mobile development.
4850
* **BLoC Pattern:** Predictable and robust state management.
4951
* **GoRouter:** Well-structured and powerful navigation.
50-
* **Benefit for you:** An easy-to-understand, extendable, and testable foundation for your project. 📈
52+
> **Your Advantage:** The app is built on a clean, modern architecture that's easy to understand and maintain. It's solid and built to last. 📈
5153
5254
#### ⚙️ **Flexible Environment Configuration**
5355
Easily switch between development (in-memory data or local API) and production environments with a simple code change. This empowers rapid prototyping, robust testing, and seamless deployment.
54-
* **Benefit for you:** Accelerate your development cycle and ensure your app is always ready for any deployment scenario. 🚀
56+
> **Your Advantage:** A flexible setup that speeds up your development cycle and makes deployment simple. 🚀
5557
5658
#### 🌍 **Localization Ready**
5759
Fully internationalized with working English and Arabic localizations (`.arb` files). Adding more languages is straightforward.
58-
* **Benefit for you:** Easily adapt your application for a global audience. 🌐
60+
> **Your Advantage:** Easily adapt your application for a global audience and tap into new markets. 🌐
5961
6062
---
6163

6264
## 🔑 Licensing
6365

64-
This package is source-available and licensed under the [PolyForm Free Trial 1.0.0](LICENSE). Please review the terms before use.
66+
This app is source-available and licensed under the [PolyForm Free Trial 1.0.0](LICENSE). This lets you try out the full source code before you buy.
6567

66-
For commercial licensing options that grant the right to build and distribute unlimited applications, please visit the main [**Flutter News App - Full Source Code Toolkit**](https://github.com/flutter-news-app-full-source-code) organization.
68+
For a commercial license to build and distribute your app, please visit the main [**Flutter News App - Full Source Code Toolkit**](https://github.com/flutter-news-app-full-source-code) organization.
6769

6870

6971
---
7072

71-
## 🚀 Getting Started
73+
## 🚀 Getting Started & Running Locally
7274

7375
1. **Ensure Flutter is installed.** (See [Flutter documentation](https://flutter.dev/docs/get-started/install))
7476
2. **Clone the repository:**
@@ -81,10 +83,24 @@ For commercial licensing options that grant the right to build and distribute un
8183
flutter pub get
8284
```
8385
4. **Run the app:**
84-
```bash
85-
flutter run
86-
```
87-
*(Note: For full functionality, ensure the `ht-api` backend service is running and accessible.)*
86+
87+
### Running the App
88+
89+
To run the app, first select your desired environment in `lib/main.dart`:
90+
91+
```dart
92+
// lib/main.dart
93+
94+
// Use `AppEnvironment.demo` to run with in-memory data (no API needed).
95+
// Use `AppEnvironment.development` to connect to a local backend API.
96+
const appEnvironment = AppEnvironment.demo;
97+
```
98+
99+
Then, run the app from your terminal:
100+
```bash
101+
flutter run
102+
```
103+
*(Note: For `development` environment, ensure the [backend service](https://github.com/flutter-news-app-full-source-code/flutter-news-app-api-server-full-source-code) is running.)*
88104

89105
---
90106

@@ -95,4 +111,3 @@ This project aims for high test coverage to ensure quality and reliability.
95111
* Run tests with:
96112
```bash
97113
flutter test
98-
```

0 commit comments

Comments
 (0)