Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

39 lines (24 loc) · 1.47 KB

Welcome to client-sdk-dart contributing guide 👋

Thank you for taking your time to contribute to our Dart SDK!
This guide will provide you information to start your own development and testing.
Happy coding 💃

Requirements ☕


Developer Setup

If you're using the IntelliJ IDE for development, you may want to install the dart plugin.

To install the repository's dependencies, run dart pub get.

To lint your files while developing, run dart format . from the root of the repository.

Examples

All examples are in subdirectories of example. We currently have a publish-and-subscribe example app in example/topics that demonstrates how to use the Momento Topic Client to both publish and subscribe to a topic, as well as an example Flutter app in example/flutter_chat_app that uses Momento Topics to create a chat app demo.

Build 💻

You can build the SDK for a specific platform using the dart compile command from the root of the repository.

Running tests

You can use the this command from the root of the repository to run the tests:

TEST_API_KEY=<your api key> dart test