Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/pooranjoyb/cpp-sdk-appwrite

[UNOFFICIAL] First-Ever C++ SDK for Appwrite, Built from Scratch!
https://github.com/pooranjoyb/cpp-sdk-appwrite

appwrite cpp sdk sdk-cpp

Last synced: 19 days ago
JSON representation

[UNOFFICIAL] First-Ever C++ SDK for Appwrite, Built from Scratch!

Host: GitHub
URL: https://github.com/pooranjoyb/cpp-sdk-appwrite
Owner: pooranjoyb
License: mit
Created: 2024-10-03T18:29:08.000Z (3 months ago)
Default Branch: master
Last Pushed: 2024-12-23T05:07:04.000Z (20 days ago)
Last Synced: 2024-12-23T06:21:46.963Z (20 days ago)
Topics: appwrite, cpp, sdk, sdk-cpp
Language: C++
Homepage: https://pooranjoyb.github.io/cpp-sdk-appwrite/
Size: 9.89 MB
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Appwrite C++ SDK

![C++](https://img.shields.io/badge/c++-%2300599C.svg?style=flat-square&logo=c%2B%2B&logoColor=white)

![Appwrite](https://img.shields.io/badge/Appwrite-%23FD366E.svg?style=flat-square&logo=appwrite&logoColor=white)

![GitHub License](https://img.shields.io/github/license/pooranjoyb/cpp-sdk-appwrite?style=flat-square)

![Version](https://img.shields.io/badge/api%20version-0.0.1-blue.svg?style=flat-square)

![banner-appwrite](https://github.com/user-attachments/assets/63e7dbad-6a49-4b80-bee2-8e0a46601eec)

## Overview

This **C++ SDK** is built from scratch as a **prototype** for interacting with Appwrite's backend services. 

- It allows users to perform a limited set of functionalities as of now,

- including the **creation of databases, collections, and documents**,

- while also enabling the **retrieval of usage statistics** and

- management of **storage** and **account health**.

**This SDK is compatible with Appwrite server version 1.6.x.**

![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)

## Installation

### Build From Source Code

Clone the repository and run the following commands

```bash

mkdir build

cd build

cmake ..

make

```

Install the SDK.

```bash

sudo make install

```

## Getting Started

### Make Your First Request

Set the neccessary header files.

```cpp

#include "Appwrite.hpp"

```

Once your SDK header is set, create the Appwrite service objects and choose the request to send.

```cpp

    std::string projectId = "";

    std::string apiKey = ""; 

    Appwrite appwrite(projectId);

    // for the Databases instance

    Databases& databases = appwrite.getDatabases();

    databases.setup(apiKey, projectId);

```

### Full Example

```cpp

#include "Appwrite.hpp"

#include 

int main() {

    std::string projectId = "";

    std::string apiKey = ""; 

    std::string databaseId = "";

    std::string name = "";

    bool enabled = true;

    Appwrite appwrite(projectId);

    Databases& databases = appwrite.getDatabases();

    

    databases.setup(apiKey, projectId);

    std::string response = databases.create(databaseId, name, enabled);

    return 0;

}    

```

### Error Handling

The Appwrite C++ SDK raises `AppwriteException` object with `message`, `code` and `response` properties. You can handle any errors by catching `AppwriteException` and present the `message` to the user or handle it yourself based on the provided error information. Below is an example.

```cpp

    try {

        // Send some request here

    } catch (const AppwriteException& ex) {

        std::cerr << "Exception: " << ex.what() << std::endl;

    }

```

### Compilation & Execution

```bash

# Compile

g++ -o  .cpp -I/usr/local/include/AppwriteSDK -L/usr/local/lib -lAppwriteSDK -lcurl

# Execute

./output-file-name

```

For a more detailed view of the implementations, please check out the example directory. [Example](/examples/)

### Learn more

You can use the following resources to learn more and get help

- 🚀 [Getting Started Tutorial](https://www.youtube.com/watch?v=L1D-Ibe7XeU)

- 📜 [C++ SDK Docs](/docs)

## License 

This project is licensed under the MIT License, and further details can be found in the [LICENSE](LICENSE) file.