https://github.com/pooranjoyb/cpp-sdk-appwrite
First-Ever C++ SDK for Appwrite, Built from Scratch!
https://github.com/pooranjoyb/cpp-sdk-appwrite
appwrite cpp jwoc sdk sdk-cpp unofficial
Last synced: 9 months ago
JSON representation
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 (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-08T10:31:19.000Z (10 months ago)
- Last Synced: 2025-04-14T00:15:14.952Z (9 months ago)
- Topics: appwrite, cpp, jwoc, sdk, sdk-cpp, unofficial
- Language: C++
- Homepage: https://pooranjoyb.github.io/cpp-sdk-appwrite/
- Size: 11 MB
- Stars: 6
- Watchers: 2
- Forks: 5
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Appwrite C++ SDK
## 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.**
## Installation
### Prerequisites
Before you begin, ensure that you have Conan installed on your system. You can install Conan using `pip`:
```bash
pip install conan
```
### Build From Source Code
Clone the repository and run the following commands
```bash
mkdir build && cd build
conan install .. --build=missing
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();
```
### 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, apiKey);
std::string response = appwrite.getDatabases().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
- ### Compile
```bash
g++ -o .cpp -I/usr/local/include/AppwriteSDK -L/usr/local/lib -lAppwriteSDK -lcurl
```
- ### Execute
```bash
./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.