Kuzzle Dart SDK

About Kuzzle

A backend software, self-hostable and ready to use to power modern apps.

You can access the Kuzzle repository on Github or view official website kuzzle.io.

• Installation
• Basic usage
• Documentation and Samples
• Contribution

Installation

Include this in your pubspec.yaml

dependencies:
  kuzzle: ^2.0.0-alpha.1

Basic usage

import 'package:kuzzle/kuzzle.dart';

final kuzzle = Kuzzle(
  WebSocketProtocol('127.0.0.1.xip.io'),
  offlineMode: OfflineMode.auto,
);

void main () async {
  // note that we don't need to await connection to be effective
  kuzzle.connect(); 
  
  final result = await kuzzle.server.info();
  print('[result][server][info] $result');
}

only WebSocketProtocol protocol is available for now, feel free to suggest a PR for other protocols submissions

Documentation and Samples

• https://prijindal.github.io/kuzzle_dart/ - Access the auto generated documentation from source code
• https://docs.kuzzle.io/core/1/api - Official Kuzzle API documentation
• example/ folder - Various samples about using this library

Contributions

If you find a bug or want a feature, but don't know how to fix/implement it, feel free to open an issue. If you fixed a bug or implemented a new feature, we will enjoy to merge your pull request.

Contributors

• stafyniaksacha
• Manuelbaun
• prijindal
• Aschen