Skip to content

Latest commit

 

History

History
87 lines (58 loc) · 1.51 KB

File metadata and controls

87 lines (58 loc) · 1.51 KB

Contribution

Thanks for your interest in contributing! Feedback and Pull Requests are most welcome!

Also, you can join our Slack Community and say hello 👋️!

Prerequisites

  • 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

Getting started

Clone the repository:

git clone https://github.com/typesense/typesense-dart.git
cd typesense-dart

Install dependencies:

dart pub get

Running tests

Generate test mocks:

dart run build_runner build

Start the local Typesense server (via Docker):

docker compose up -d

Run all tests:

dart test

Stop the Typesense server:

docker compose down

Formatting

dart format .

Static analysis

dart analyze

Before submitting

Please ensure:

  • All tests pass
  • Code is formatted dart format .
  • dart analyze reports no issues
  • New features include tests

Thank you!