{"id":13720997,"url":"https://github.com/kuzzleio/sdk-csharp","last_synced_at":"2025-05-07T08:45:13.373Z","repository":{"id":45077956,"uuid":"150559041","full_name":"kuzzleio/sdk-csharp","owner":"kuzzleio","description":"Official C# SDK for Kuzzle","archived":false,"fork":false,"pushed_at":"2021-08-10T09:12:54.000Z","size":2180,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-20T06:35:40.623Z","etag":null,"topics":["asynchronous","csharp","kuzzle","kuzzle-sdk","nuget","offline-first"],"latest_commit_sha":null,"homepage":"http://docs.kuzzle.io/sdk/csharp/2","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kuzzleio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-27T09:05:02.000Z","updated_at":"2023-09-08T17:45:30.000Z","dependencies_parsed_at":"2022-09-02T22:51:17.695Z","dependency_job_id":null,"html_url":"https://github.com/kuzzleio/sdk-csharp","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fsdk-csharp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fsdk-csharp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fsdk-csharp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kuzzleio%2Fsdk-csharp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kuzzleio","download_url":"https://codeload.github.com/kuzzleio/sdk-csharp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252846387,"owners_count":21813424,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asynchronous","csharp","kuzzle","kuzzle-sdk","nuget","offline-first"],"created_at":"2024-08-03T01:01:10.996Z","updated_at":"2025-05-07T08:45:13.352Z","avatar_url":"https://github.com/kuzzleio.png","language":"C#","readme":"[![Build Status](https://travis-ci.org/kuzzleio/sdk-csharp.svg?branch=master)](https://travis-ci.org/kuzzleio/sdk-csharp)\n[![codecov.io](http://codecov.io/github/kuzzleio/sdk-csharp/coverage.svg?branch=master)](http://codecov.io/github/kuzzleio/sdk-csharp?branch=master)\n\n\n## About\n\n### Kuzzle C# SDK\n\nThis is the official C# SDK for the free and open-source backend Kuzzle. It provides a way to dial with a Kuzzle server from C# applications.\n\n#### Asynchronous\n\nAll SDK methods are asynchronous using C# `Task`.  \nFor example, for the action create of the controller collection (_collection:create_), the API result contains `{ \"acknowledged\": true }` . This is therefore what will be returned inside a `JObject` by the SDK method if successful.  \n\n\u003cp align=\"center\"\u003e\n  :books: \u003cb\u003e\u003ca href=\"https://docs.kuzzle.io/sdk-reference/csharp/1/\"\u003eDocumentation\u003c/a\u003e\u003c/b\u003e\n\u003c/p\u003e\n\n### Kuzzle\n\nKuzzle is an open-source backend that includes a scalable server, a multiprotocol API,\nan administration console and a set of plugins that provide advanced functionalities like real-time pub/sub, blazing fast search and geofencing.\n\n* :octocat: __[Github](https://github.com/kuzzleio/kuzzle)__\n* :earth_africa: __[Website](https://kuzzle.io)__\n* :books: __[Documentation](https://docs-v2.kuzzle.io)__\n* :email: __[Discord](http://join.discord.kuzzle.io)__\n\n\n#### Get trained by the creators of Kuzzle :zap:\n\nTrain yourself and your teams to use Kuzzle to maximize its potential and accelerate the development of your projects.  \nOur teams will be able to meet your needs in terms of expertise and multi-technology support for IoT, mobile/web, backend/frontend, devops.  \n:point_right: [Get a quote](https://hubs.ly/H0jkfJ_0)\n\n## Usage\n\n### Compatibility matrix\n\n| Kuzzle Version | SDK Version |\n|----------------|-------------|\n| 1.x.x          | 1.x.x       |\n| 2.x.x          | 2.x.x       |\n\n### Getting started :point_right:\n\n  - [Standalone](https://docs.kuzzle.io/sdk/csharp/2/getting-started/standalone/)\n\n### Installation\n\n#### NuGet\n\nThe SDK is available on [NuGet](https://www.nuget.org/packages/kuzzlesdk/).  \n\n### Example\n\n```csharp\nusing KuzzleSdk;\nusing KuzzleSdk.Protocol;\n\nWebSocket socket = new WebSocket(new Uri(\"ws://kuzzle:7512\"));\nKuzzleSdk.Kuzzle kuzzle = new KuzzleSdk.Kuzzle(socket);\n\nawait kuzzle.ConnectAsync(CancellationToken.None);\n\nInt64 now = await kuzzle.Server.NowAsync();\nConsole.WriteLine(\"Epoch-millis timestamp: \" + now);\n```\n\n## Compile \u0026 test\n\nPreprequisites:\n- .NET Core SDK 2.1 \n\nCompile with the following command lines:\n\n```\n$ dotnet restore\n$ dotnet build Kuzzle/Kuzzle.csproj -c Release\n```\n\nTo start the unit tests using the command line:\n\n```\n$ dotnet test\n```\n\n### monodevelop\n\nIf you're using monodevelop, you'll need at least mono 5.20+ (w/ msbuild 16+). Due to compatibility problems, you HAVE TO install .NET Core SDK 2.1, if you only have the 2.2 one, you won't be able to build the project with msbuild (which monodevelop uses).\n","funding_links":[],"categories":["SDKs"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkuzzleio%2Fsdk-csharp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkuzzleio%2Fsdk-csharp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkuzzleio%2Fsdk-csharp/lists"}