You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**This SDK is compatible with Appwrite server version 0.7.0. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-ruby/releases).**
8
+
**This SDK is compatible with Appwrite server version 0.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-ruby/releases).**
7
9
8
10
Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way.
9
11
Use the Ruby SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools.
@@ -19,6 +21,73 @@ To install via [Gem](https://rubygems.org/):
19
21
gem install appwrite --save
20
22
```
21
23
24
+
25
+
## Getting Started
26
+
27
+
### Init your SDK
28
+
Initialize your SDK code with your project ID which can be found in your project settings page and your new API secret Key from project's API keys section.
29
+
30
+
```ruby
31
+
require'appwrite'
32
+
33
+
client =Appwrite::Client.new()
34
+
35
+
client
36
+
.set_endpoint(ENV["APPWRITE_ENDPOINT"]) # Your API Endpoint
37
+
.set_project(ENV["APPWRITE_PROJECT"]) # Your project ID
38
+
.set_key(ENV["APPWRITE_SECRET"]) # Your secret API key
39
+
.setSelfSigned() # Use only on dev mode with a self-signed SSL cert
40
+
;
41
+
```
42
+
43
+
### Make Your First Request
44
+
Once your SDK object is set, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the API References section.
45
+
46
+
```ruby
47
+
users =Appwrite::Users.new(client);
48
+
49
+
result = users.create(email:'email@example.com', password:'password');
50
+
```
51
+
52
+
### Full Example
53
+
```ruby
54
+
require'appwrite'
55
+
56
+
client =Appwrite::Client.new()
57
+
58
+
client
59
+
.set_endpoint(ENV["APPWRITE_ENDPOINT"]) # Your API Endpoint
60
+
.set_project(ENV["APPWRITE_PROJECT"]) # Your project ID
61
+
.set_key(ENV["APPWRITE_SECRET"]) # Your secret API key
62
+
.setSelfSigned() # Use only on dev mode with a self-signed SSL cert
63
+
;
64
+
65
+
users =Appwrite::Users.new(client);
66
+
67
+
result = users.create(email:'email@example.com', password:'password');
68
+
```
69
+
70
+
### Error Handling
71
+
The Appwrite Ruby SDK raises `Appwrite::Exception` object with `message`, `code` and `response` properties. You can handle any errors by catching `Appwrite::Exception` and present the `message` to the user or handle it yourself based on the provided error information. Below is an example.
72
+
73
+
```ruby
74
+
users =Appwrite::Users.new(client);
75
+
76
+
begin
77
+
result = users.create(email:'email@example.com', password:'password');
78
+
rescueAppwrite::Exception => error
79
+
puts error.message
80
+
end
81
+
```
82
+
83
+
### Learn more
84
+
You can use followng resources to learn more and get help
85
+
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.
s.summary="Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API"
0 commit comments