|
2 | 2 |
|
3 | 3 | ## 📖 Overview |
4 | 4 |
|
5 | | -**Headlines Toolkit** is a source-available, full-stack Flutter application designed to provide a foundation for building news apps. It offers a streamlined, user-friendly experience for browsing news headlines and is built with a clean, maintainable architecture. Developers can freely evaluate the source code and run the app locally for a 32-day trial period. A commercial license is required for any use beyond this trial, including continued local use, modification, production use, or distribution. |
| 5 | +**Headlines Toolkit** is a source-available, full-stack Flutter application designed as a robust foundation for building modern news applications. This toolkit offers a streamlined, user-friendly experience for browsing news headlines and is built upon a clean, maintainable architecture. Developers can freely evaluate the source code and run the app locally for a 32-day trial period. A commercial license is required for any use beyond this trial, including continued local use, modification, production use, or distribution. |
6 | 6 |
|
7 | 7 | ## ✨ Features |
8 | 8 |
|
|
36 | 36 |
|
37 | 37 | This project is source-available under the [PolyForm Free Trial License 1.0.0](LICENSE). This license allows for free evaluation of the Headlines Toolkit source code and local execution of the application for up to 32 consecutive days. Any use beyond this trial period, including continued local use, modification, production use, or distribution, requires a commercial license. |
38 | 38 |
|
39 | | -## 💰 Commercial License |
40 | | - |
41 | | -A commercial license covers all repositories within the Headlines Toolkit organization, including the backend and any related packages. This provides licensees with a complete, full-stack solution for building their news applications. The commercial license grants developers the rights to use the source code in production, customize it to their needs, and distribute their derived applications. |
42 | | - |
43 | | -## 🚀 Getting Started |
44 | | - |
45 | | -1. **Clone the repository:** |
46 | | - |
47 | | - ```bash |
48 | | - git clone https://github.com/headlines-toolkit/ht-main |
49 | | - ``` |
50 | | -2. **Navigate to the project directory:** |
51 | | - |
52 | | - ```bash |
53 | | - cd ht-main |
54 | | - ``` |
55 | | -3. **Get dependencies:** |
56 | 39 |
|
57 | | - ```bash |
58 | | - flutter pub get |
59 | | - ``` |
60 | | -4. **Run the app (development flavor):** |
61 | | - |
62 | | - ```bash |
63 | | - flutter run -t lib/main_development.dart |
64 | | - ``` |
65 | | - |
66 | | - This will run the app using the in-memory data client. |
67 | | - |
68 | | -## 🗂️ Project Structure |
69 | | - |
70 | | -The project is organized using a feature-based directory structure within the `lib` folder: |
| 40 | +## 💰 Commercial License |
71 | 41 |
|
72 | | -``` |
73 | | -lib/ |
74 | | -├── app/ # Main application widget, app-level BLoCs, and views |
75 | | -├── headlines-feed/ # Headlines feed feature |
76 | | -├── headlines-search/ # Headlines search feature |
77 | | -├── l10n/ # Localization files |
78 | | -├── router/ # Routing configuration |
79 | | -└── shared/ # Reusable widgets and utilities |
80 | | -``` |
| 42 | +A commercial license covers all repositories within the Headlines Toolkit organization. This provides licensees with a complete, full-stack solution for building and managing their news applications. The Headlines Toolkit organization includes two source-available applications: this Flutter mobile app and a Flutter web dashboard for managing the app's content. The commercial license grants developers the rights to use the source code of both applications in production, customize them to their needs, and distribute their derived applications. **Purchase a commercial license online: [INSERT LINK HERE]**. |
0 commit comments