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 💃
- Dart version 3 or higher is required.
- A Momento API key is required, you can generate one using the Momento Console
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.
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.
You can build the SDK for a specific platform using the dart compile command from the root of the repository.
You can use the this command from the root of the repository to run the tests:
MOMENTO_API_KEY=<your api key> dart testFollow instructions for setting up the protoc plugin.
Copy over the necessary files from the client-protos repo.
Then run the generate.sh script to generate Dart code for the proto files.