Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prijindal/kuzzle_dart

Moved to https://github.com/kuzzleio/sdk-dart
https://github.com/prijindal/kuzzle_dart

dart kuzzle kuzzle-dart

Last synced: 3 months ago
JSON representation

Moved to https://github.com/kuzzleio/sdk-dart

Host: GitHub
URL: https://github.com/prijindal/kuzzle_dart
Owner: prijindal
License: mit
Created: 2018-11-30T08:05:32.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2020-04-15T12:56:23.000Z (over 4 years ago)
Last Synced: 2024-06-23T12:44:50.745Z (4 months ago)
Topics: dart, kuzzle, kuzzle-dart
Language: Dart
Homepage:
Size: 1.86 MB
Stars: 15
Watchers: 3
Forks: 8
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Awesome Flutter](https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square)](https://stackoverflow.com/questions/tagged/flutter?sort=votes)

[![Pub](https://img.shields.io/pub/v/kuzzle.svg?style=flat-square)](https://pub.dartlang.org/packages/kuzzle)

[![codecov](https://img.shields.io/codecov/c/github/prijindal/kuzzle_dart/master.svg?style=flat-square)](https://codecov.io/gh/prijindal/kuzzle_dart)

[![Build Status](https://img.shields.io/travis/prijindal/kuzzle_dart/master.svg?style=flat-square)](https://travis-ci.org/prijindal/kuzzle_dart)

# 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](https://github.com/kuzzleio/kuzzle) or view official website [kuzzle.io](https://kuzzle.io).

* [Installation](#installation)

* [Basic usage](#basic-usage)

* [Documentation and Samples](#documentation-and-samples)

* [Contribution](#contribution)

## Installation

Include this in your pubspec.yaml

```yaml

dependencies:

  kuzzle: ^2.0.0-alpha.1

```

## Basic usage

```dart

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/](https://prijindal.github.io/kuzzle_dart/) - 

  _Access the auto generated documentation from source code_

* [https://docs.kuzzle.io/core/1/api](https://docs.kuzzle.io/core/1/api) - 

  _Official Kuzzle API documentation_

* [example/ folder](./example/) - 

  _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