Skip to content

Commit 471c000

Browse files
committed
docs(README): comprehensive update with new structure and content
- Redesigned header with logo and badges - Updated project description and features list - Added new sections: Dashboard Analytics, Robust User Authentication, Responsive Web UI - Improved readability with better formatting and structure - Updated license information and added purchase options - Clarified getting started instructions
1 parent e6913c5 commit 471c000

File tree

1 file changed

+70
-52
lines changed

1 file changed

+70
-52
lines changed

README.md

Lines changed: 70 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,79 @@
1-
# 📊✨ flutter_news_app_web_dashboard_full_source_code
1+
<div align="center">
2+
<img src="https://avatars.githubusercontent.com/u/202675624?s=400&u=2daf23e8872a3b666bcd4f792a21fe2633097e79&v=4" alt="Flutter News App Toolkit Logo" width="220">
23

3-
![coverage: percentage](https://img.shields.io/badge/coverage-XX-green)
4-
[![Demo: Live](https://img.shields.io/badge/Demo-Live-orange)](https://flutter-news-app-full-source-code.github.io/flutter-news-app-web-dashboard-full-source-code/)
5-
[![style: very good analysis](https://img.shields.io/badge/style-very_good_analysis-B22C89.svg)](https://pub.dev/packages/very_good_analysis)
6-
[![License: PolyForm Free Trial](https://img.shields.io/badge/License-PolyForm%20Free%20Trial-blue)](https://polyformproject.org/licenses/free-trial/1.0.0)
4+
# Flutter News App - Web Dashboard Full Source Code
75

8-
`flutter_news_app_web_dashboard_full_source_code` is a Flutter web application designed as a comprehensive content management and administration interface for the [Headlines Toolkit](https://github.com/flutter-news-app-full-source-code) ecosystem. It provides a powerful, intuitive platform for managing news content, application configurations, and user-related settings, complementing the [mobile app](https://github.com/flutter-news-app-full-source-code/ht-main) and the [backend service](https://github.com/flutter-news-app-full-source-code/ht-api).
6+
<p>
7+
<img src="https://img.shields.io/badge/coverage-XX-green?style=for-the-badge" alt="coverage: percentage">
8+
<a href="https://flutter-news-app-full-source-code.github.io/flutter-news-app-web-dashboard-full-source-code/"><img src="https://img.shields.io/badge/Demo-Live-orange?style=for-the-badge" alt="Demo: Live"></a>
9+
<a href="https://github.com/sponsors/flutter-news-app-full-source-code"><img src="https://img.shields.io/badge/DOCS-READ-purple?style=for-the-badge" alt="DOCS READ"></a>
10+
<a href="https://github.com/sponsors/flutter-news-app-full-source-code"><img src="https://img.shields.io/badge/LICENSE-BUY-pink?style=for-the-badge" alt="License: Buy"></a>
11+
</p>
12+
</div>
913

10-
## ⭐ Features & Capabilities
14+
This is a complete and fully-functional Flutter web application for comprehensive content management and administration. 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 [mobile client](https://github.com/flutter-news-app-full-source-code/flutter-news-app-mobile-client-full-source-code).
1115

12-
`flutter_news_app_web_dashboard_full_source_code` offers a robust set of tools for efficient administration:
16+
## ⭐ Everything You Get, Ready to Go
17+
18+
This dashboard comes packed with all the features you need to manage a professional news application.
1319

1420
#### 📰 **Comprehensive Content Management**
15-
Effortlessly manage all aspects of your news content, including:
16-
* **Headlines:** Create, edit, and delete news articles.
17-
* **Categories:** Organize and define news categories.
21+
Effortlessly manage all aspects of your news content with full CRUD (Create, Read, Update, Delete) capabilities:
22+
* **Headlines:** Create, edit, and publish news articles.
23+
* **Topics:** Organize and define news topics.
1824
* **Sources:** Maintain and update news sources.
19-
* **Benefit for you:** Centralized control over your content, ensuring accuracy and consistency across your news platform. ✍️
25+
> **Your Advantage:** You get a powerful, centralized system to control your content, ensuring accuracy and consistency across your news platform. ✍️
2026
2127
#### ⚙️ **Dynamic Application Configuration**
22-
Control the behavior and appearance of the `ht_main` mobile application remotely:
23-
* **User Preference Limits:** Set limits for followed items and saved headlines
24-
based on user roles (Guest, Authenticated, Premium).
25-
* **Ad Settings:** Configure ad frequency and placement intervals for
26-
different user tiers.
27-
* **In-App Prompts:** Manage the display frequency of account-related
28-
calls-to-action.
29-
* **Operational Status (Kill Switch):** Remotely enable maintenance mode or
30-
disable the app.
31-
* **Force Update:** Mandate or suggest app updates to users.
32-
* **Benefit for you:** Granular control over app features and monetization
33-
strategies without requiring app store updates. 🚀
34-
35-
#### 📊 **Intuitive User Interface**
36-
Built with Flutter, the dashboard provides a responsive and user-friendly
37-
experience across various web browsers and screen sizes.
38-
* **User-Friendly Error Handling:** Displays clear, localized error messages for a smooth and understandable user experience when issues arise.
39-
* **Benefit for you:** A modern, maintainable, and visually appealing
40-
interface for your administrative tasks. ✨
28+
Control the behavior and appearance of the mobile application remotely:
29+
* **User Preference Limits:** Set limits for followed items and saved headlines based on user roles (Guest, Authenticated, Premium).
30+
* **Ad Settings:** Configure ad frequency and placement intervals for different user tiers.
31+
* **In-App Prompts:** Manage the display frequency of account-related calls-to-action.
32+
* **Operational Status:** Remotely enable maintenance mode or suggest app updates to users.
33+
> **Your Advantage:** Granular control over app features and monetization strategies without requiring app store updates. 🚀
34+
35+
#### 📊 **Dashboard Analytics**
36+
Get a quick overview of your content ecosystem with key statistics:
37+
* **Content Counts:** View the total number of headlines, topics, and sources at a glance.
38+
> **Your Advantage:** Instantly understand the scale of your content operation. 📈
39+
40+
#### 🔐 **Robust User Authentication**
41+
Secure and flexible authentication flows are built-in for administrators and publishers using Email + Code (Passwordless) Sign-In.
42+
> **Your Advantage:** All the complex security and user management for your administrative team is already done for you. ✅
43+
44+
#### 🖥️ **Responsive Web UI**
45+
Built with `flutter_adaptive_scaffold`, the dashboard offers a clean, responsive interface that looks great on any screen size.
46+
> **Your Advantage:** Deliver a consistent and optimized administrative experience on desktops, tablets, and even mobile browsers. ↔️
4147
4248
#### 🏗️ **Clean & Modern Architecture**
4349
Developed with best practices for a maintainable and scalable codebase:
4450
* **Flutter & Dart:** Cutting-edge web development.
4551
* **BLoC Pattern:** Predictable and robust state management.
4652
* **GoRouter:** Well-structured and powerful navigation.
47-
* **Adaptive UI:** Responsive layouts using `flutter_adaptive_scaffold` for
48-
optimal experience on different screen sizes.
49-
* **Benefit for you:** An easy-to-understand, extendable, and testable
50-
foundation for your project. 📈
53+
> **Your Advantage:** The dashboard is built on a clean, modern architecture that's easy to understand and maintain. It's solid and built to last. 📈
54+
55+
#### ⚙️ **Flexible Environment Configuration**
56+
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.
57+
> **Your Advantage:** A flexible setup that speeds up your development cycle and makes deployment simple. 🚀
5158
5259
#### 🌍 **Localization Ready**
53-
Fully internationalized with working English and Arabic localizations (`.arb` files).
54-
* **Benefit for you:** Easily adapt your dashboard for a global team. 🌐
60+
Fully internationalized with working English and Arabic localizations (`.arb` files). Adding more languages is straightforward.
61+
> **Your Advantage:** Easily adapt your dashboard for a global team. 🌐
5562
5663
---
5764

58-
## 🔑 Access and Licensing
65+
## 🔑 License: Source-Available with a Free Trial
5966

60-
`flutter_news_app_web_dashboard_full_source_code` is source-available as part of the Headlines Toolkit ecosystem.
67+
Get started for free and purchase when you're ready to launch!
6168

62-
To acquire a commercial license for building unlimited news applications, please visit
63-
the [Headlines Toolkit GitHub organization page](https://github.com/flutter-news-app-full-source-code)
64-
for more details.
69+
* **TRY IT:** Download and explore the full source code under the polyForm free trial [license](LICENSE). Perfect for evaluation.
70+
* **BUY IT:** Get an unlimited commercial lifetime license with a **one-time payment**. No subscriptions!
71+
* **GET YOURS:** [**Purchase via GitHub Sponsors**](https://github.com/sponsors/flutter-news-app-full-source-code).
6572

73+
> *<p style="color:grey">Note: The single purchase provides a comprehensive commercial license covering every repository within the [Flutter News App - Full Source Code Toolkit](https://github.com/flutter-news-app-full-source-code) organization. No separate purchases are needed for the API or mobile client.</p>*
6674
---
6775

68-
## 🚀 Getting Started
76+
## 🚀 Getting Started & Running Locally
6977

7078
1. **Ensure Flutter is installed.** (See [Flutter documentation](https://flutter.dev/docs/get-started/install))
7179
2. **Clone the repository:**
@@ -77,13 +85,25 @@ for more details.
7785
```bash
7886
flutter pub get
7987
```
80-
4. **Run the app for web:**
81-
```bash
82-
flutter run -d chrome
83-
# Or to run on a web server (e.g., for CORS testing with ht_api)
84-
# flutter run -d web-server --web-hostname 0.0.0.0 --web-port 3000
85-
```
86-
*(Note: For full functionality, ensure the `ht_api` backend service is running and accessible. If running `ht_api` locally, ensure its `CORS_ALLOWED_ORIGIN` environment variable is configured to allow requests from the dashboard's origin, e.g., `http://localhost:3000` if using the web-server option.)*
88+
4. **Run the app:**
89+
90+
### Running the App
91+
92+
To run the app, first select your desired environment in `lib/main.dart`:
93+
94+
```dart
95+
// lib/main.dart
96+
97+
// Use `AppEnvironment.demo` to run with in-memory data (no API needed).
98+
// Use `AppEnvironment.development` to connect to a local backend API.
99+
const appEnvironment = AppEnvironment.demo;
100+
```
101+
102+
Then, run the app from your terminal:
103+
```bash
104+
flutter run -d chrome
105+
```
106+
*(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.)*
87107

88108
---
89109

@@ -94,5 +114,3 @@ This project aims for high test coverage to ensure quality and reliability.
94114
* Run tests with:
95115
```bash
96116
flutter test
97-
```
98-
*(Note: Ensure `very_good_cli` is activated: `dart pub global activate very_good_cli`)*

0 commit comments

Comments
 (0)