stream_feed 0.1.1
stream_feed: ^0.1.1 copied to clipboard
Stream Feed official Dart SDK. Build your own feed experience using Dart and Flutter.
Official Dart Client for Stream Activity Feeds #
The official Dart client for Stream Activity Feeds, a service for building feed applications. This library can be used on any Dart project and on both mobile and web apps with Flutter.
🔗 Quick Links
- Register to get an API key for Stream Activity Feeds
- Stream Activity Feeds UI Kit
Changelog #
Check out the changelog on pub.dev to see the latest changes in the package.
Getting started #
Add dependency #
Add this to your package's pubspec.yaml file, use the latest version
dependencies:
stream_feed: ^latest-version
You should then run flutter packages get
🔮 Example Project #
There is a detailed Flutter example project in the example
folder. You can directly run and play on it.
🛠 Setup API Client #
First you need to instantiate a feed client. The Feed client will manage API calls. You should only create the client once and re-use it across your application.
final client = StreamFeedClient.connect("stream-feed-api-key",token:userToken);
Contributing #
Code conventions #
- Make sure that you run
dartfmt
before commiting your code - Make sure all public methods and functions are well documented
Running tests #
- run
flutter test
Releasing a new version #
-
update the package version on
pubspec.yaml
andversion.dart
-
add a changelog entry on
CHANGELOG.md
-
run
flutter pub publish
to publish the package
Watch models and generate JSON code #
JSON serialization relies on code generation; make sure to keep that running while you make changes to the library
flutter pub run build_runner watch