Thanks for your interest in contributing! Feedback and Pull Requests are most welcome!
Also, you can join our Slack Community and say hello 👋️!
- Dart SDK 3.6.1+
- A running Typesense server for testing (Docker is recommended)
You can override the default testing server connection via the following environment variables:
| Variable | Default |
|---|---|
TYPESENSE_HOST |
127.0.0.1 |
TYPESENSE_PORT |
8108 |
TYPESENSE_PROTOCOL |
http |
TYPESENSE_API_KEY |
xyz |
Clone the repository:
git clone https://github.com/typesense/typesense-dart.git
cd typesense-dartInstall dependencies:
dart pub getGenerate test mocks:
dart run build_runner buildStart the local Typesense server (via Docker):
docker compose up -dRun all tests:
dart testStop the Typesense server:
docker compose downdart format .dart analyzePlease ensure:
- All tests pass
- Code is formatted
dart format . dart analyzereports no issues- New features include tests
Thank you!