mirror of
https://github.com/appwrite/appwrite.git
synced 2026-05-26 13:51:13 +00:00
Merge branch 'dev' of https://github.com/appwrite/appwrite into feat-265-realtime
This commit is contained in:
@@ -0,0 +1,60 @@
|
||||
## Getting Started
|
||||
|
||||
### Init your SDK
|
||||
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.
|
||||
|
||||
```typescript
|
||||
let client = new sdk.Client();
|
||||
|
||||
client
|
||||
.setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
|
||||
.setProject('5df5acd0d48c2') // Your project ID
|
||||
.setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
|
||||
;
|
||||
|
||||
```
|
||||
|
||||
### Make your first request
|
||||
|
||||
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.
|
||||
|
||||
```typescript
|
||||
let users = new sdk.Users(client);
|
||||
|
||||
let promise = users.create('email@example.com', 'password');
|
||||
|
||||
promise.then(function (response) {
|
||||
console.log(response);
|
||||
}, function (error) {
|
||||
console.log(error);
|
||||
});
|
||||
```
|
||||
|
||||
### Full Example
|
||||
```typescript
|
||||
import * as sdk from "https://deno.land/x/appwrite/mod.ts";
|
||||
|
||||
let client = new sdk.Client();
|
||||
let users = new sdk.Users(client);
|
||||
|
||||
client
|
||||
.setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
|
||||
.setProject('5df5acd0d48c2') // Your project ID
|
||||
.setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
|
||||
;
|
||||
|
||||
let promise = users.create('email@example.com', 'password');
|
||||
|
||||
promise.then(function (response) {
|
||||
console.log(response);
|
||||
}, function (error) {
|
||||
console.log(error);
|
||||
});
|
||||
```
|
||||
|
||||
### Learn more
|
||||
You can use followng resources to learn more and get help
|
||||
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
|
||||
- 📜 [Appwrite Docs](https://appwrite.io/docs)
|
||||
- 💬 [Discord Community](https://appwrite.io/discord)
|
||||
- 🚂 [Appwrite Deno Playground](https://github.com/appwrite/playground-for-deno)
|
||||
@@ -0,0 +1 @@
|
||||
# Change Log
|
||||
@@ -0,0 +1,36 @@
|
||||
## Getting Started
|
||||
|
||||
### Initialize & Make API Request
|
||||
Once you add the dependencies, its extremely easy to get started with the SDK; All you need to do is import the package in your code, set your Appwrite credentials, and start making API calls. Below is a simple example:
|
||||
|
||||
```csharp
|
||||
using Appwrite;
|
||||
|
||||
static async Task Main(string[] args)
|
||||
{
|
||||
var client = Client();
|
||||
|
||||
client
|
||||
.setEndpoint('http://[HOSTNAME_OR_IP]/v1') // Make sure your endpoint is accessible
|
||||
.setProject('5ff3379a01d25') // Your project ID
|
||||
.setKey('cd868c7af8bdc893b4...93b7535db89')
|
||||
;
|
||||
|
||||
var users = Users(client);
|
||||
|
||||
try {
|
||||
var request = await users.create('email@example.com', 'password', 'name');
|
||||
var response = await request.Content.ReadAsStringAsync();
|
||||
Console.WriteLine(response);
|
||||
} catch (AppwriteException e) {
|
||||
Console.WriteLine(e.Message);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Learn more
|
||||
You can use followng resources to learn more and get help
|
||||
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
|
||||
- 📜 [Appwrite Docs](https://appwrite.io/docs)
|
||||
- 💬 [Discord Community](https://appwrite.io/discord)
|
||||
- 🚂 [Appwrite Dart Playground](https://github.com/appwrite/playground-for-dotnet)
|
||||
@@ -0,0 +1,49 @@
|
||||
## Getting Started
|
||||
|
||||
### Init your SDK
|
||||
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.
|
||||
|
||||
```ruby
|
||||
require 'appwrite'
|
||||
|
||||
client = Appwrite::Client.new()
|
||||
|
||||
client
|
||||
.set_endpoint(ENV["APPWRITE_ENDPOINT"]) # Your API Endpoint
|
||||
.set_project(ENV["APPWRITE_PROJECT"]) # Your project ID
|
||||
.set_key(ENV["APPWRITE_SECRET"]) # Your secret API key
|
||||
;
|
||||
```
|
||||
|
||||
### Make Your First Request
|
||||
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.
|
||||
|
||||
```ruby
|
||||
users = Appwrite::Users.new(client);
|
||||
|
||||
result = users.create(email: 'email@example.com', password: 'password');
|
||||
```
|
||||
|
||||
### Full Example
|
||||
```ruby
|
||||
require 'appwrite'
|
||||
|
||||
client = Appwrite::Client.new()
|
||||
|
||||
client
|
||||
.set_endpoint(ENV["APPWRITE_ENDPOINT"]) # Your API Endpoint
|
||||
.set_project(ENV["APPWRITE_PROJECT"]) # Your project ID
|
||||
.set_key(ENV["APPWRITE_SECRET"]) # Your secret API key
|
||||
;
|
||||
|
||||
users = Appwrite::Users.new(client);
|
||||
|
||||
result = users.create(email: 'email@example.com', password: 'password');
|
||||
```
|
||||
|
||||
### Learn more
|
||||
You can use followng resources to learn more and get help
|
||||
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
|
||||
- 📜 [Appwrite Docs](https://appwrite.io/docs)
|
||||
- 💬 [Discord Community](https://appwrite.io/discord)
|
||||
- 🚂 [Appwrite Ruby Playground](https://github.com/appwrite/playground-for-ruby)
|
||||
Reference in New Issue
Block a user