-
-
Notifications
You must be signed in to change notification settings - Fork 100
docs: improve package READMEs with quick start guides & detailed features #462
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+251
−59
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,25 @@ | ||
| # Counter Example | ||
|
|
||
| A counter example using Stac showcasing how to build a Custom Widget and Action in Stac. | ||
| A simple counter application using Stac Server-Driven UI, demonstrating how to build a Custom Widget and Action in Stac. | ||
|
|
||
| ## What this demonstrates | ||
|
|
||
| - Creating a **custom widget scaler parser** that isn't included in the default Stac framework. | ||
| - Implementing a **custom action** to increment a counter natively. | ||
| - Connecting local Dart logic with server-driven layout definitions. | ||
|
|
||
| ## How to run | ||
|
|
||
| 1. Ensure you have Flutter installed. | ||
| 2. Navigate to this directory: | ||
| ```bash | ||
| cd examples/counter_example | ||
| ``` | ||
| 3. Get dependencies: | ||
| ```bash | ||
| flutter pub get | ||
| ``` | ||
| 4. Run the app: | ||
| ```bash | ||
| flutter run | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,26 @@ | ||
| # movie_app | ||
| # Movie App Example | ||
|
|
||
| A new Flutter project. | ||
| A comprehensive example of building a full-featured application using the Stac Server-Driven UI framework. This movie application fetches data and UI layouts dynamically to display movie listings and details. | ||
|
|
||
| ## Getting Started | ||
| ## What this demonstrates | ||
|
|
||
| This project is a starting point for a Flutter application. | ||
| - Complex dynamic layouts using Stac components. | ||
| - Network data fetching combined with SDUI. | ||
| - Navigating between different server-driven screens. | ||
| - Global theming using the Stac theme system. | ||
|
|
||
| A few resources to get you started if this is your first Flutter project: | ||
| ## How to run | ||
|
|
||
| - [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) | ||
| - [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) | ||
|
|
||
| For help getting started with Flutter development, view the | ||
| [online documentation](https://docs.flutter.dev/), which offers tutorials, | ||
| samples, guidance on mobile development, and a full API reference. | ||
| 1. Ensure you have Flutter installed. | ||
| 2. Navigate to this directory: | ||
| ```bash | ||
| cd examples/movie_app | ||
| ``` | ||
| 3. Get dependencies: | ||
| ```bash | ||
| flutter pub get | ||
| ``` | ||
| 4. Run the app: | ||
| ```bash | ||
| flutter run | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,25 @@ | ||
| # stac_gallery | ||
| # Stac Gallery | ||
|
|
||
| A Stac gallery app to showcase all the Stac widgets | ||
| A gallery application built to showcase all the widgets and components available in the Stac Server-Driven UI framework. It acts as a live interactive catalog for developers. | ||
|
|
||
| ## Getting Started | ||
| ## What this demonstrates | ||
|
|
||
| This project is a starting point for a Flutter application. | ||
| - Real-world usage of every built-in Stac widget. | ||
| - Action handlers (navigation, dialogs, form submissions). | ||
| - Theming and responsive layouts purely driven by JSON. | ||
|
|
||
| A few resources to get you started if this is your first Flutter project: | ||
| ## How to run | ||
|
|
||
| - [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) | ||
| - [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) | ||
|
|
||
| For help getting started with Flutter development, view the | ||
| [online documentation](https://docs.flutter.dev/), which offers tutorials, | ||
| samples, guidance on mobile development, and a full API reference. | ||
| 1. Ensure you have Flutter installed. | ||
| 2. Navigate to this directory: | ||
| ```bash | ||
| cd examples/stac_gallery | ||
| ``` | ||
| 3. Get dependencies: | ||
| ```bash | ||
| flutter pub get | ||
| ``` | ||
| 4. Run the app: | ||
| ```bash | ||
| flutter run | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,8 @@ | ||
| ## stac_core | ||
| # Stac Core | ||
|
|
||
| A pure Dart package that provides the core functionalities and common interfaces for the [Stac](https://pub.dev/packages/stac). | ||
| [](https://pub.dev/packages/stac_core) | ||
| [](https://opensource.org/licenses/MIT) | ||
|
|
||
| This package serves as the foundation for building server-driven UIs with Stac by defining core models, functionalities, and common interfaces that stac package depend upon. | ||
| A pure Dart package that provides the core functionalities and common interfaces for the [Stac](https://pub.dev/packages/stac) SDUI framework. | ||
|
|
||
| This package serves as the foundation for building server-driven UIs with Stac by defining core models, functionalities, and common interfaces that Stac packages depend upon. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| include: package:flutter_lints/flutter.yaml | ||
| include: package:lints/recommended.yaml | ||
|
|
||
| # Additional information about this file can be found at | ||
| # https://dart.dev/guides/language/analysis-options |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.