-
Notifications
You must be signed in to change notification settings - Fork 298
Feat server sdks quickstarts #533
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
b30ed54
add php quickstart
538e9ec
Add deno
fa41045
Add ruby and swift
6091acf
Add server quickstarts
9feebbc
Update src/routes/docs/quick-starts/kotlin/+page.markdoc
daaa259
Update src/routes/docs/quick-starts/node/+page.markdoc
7562a74
Fix misuse of UUID instead of ID.unique()
b6606f7
Update src/routes/docs/quick-starts/deno/+page.markdoc
27facc4
Update src/routes/docs/quick-starts/swift/+page.markdoc
cf1b9a7
Apply suggestions from code review
4834ffd
Fix Ruby + Fix permission tables
a5c7797
Merge branch 'main' into feat-server-sdks
7a77930
Use named params + address review comments
8748dc2
Apply suggestions from code review
a59c46b
Fix swift
5b5812d
Linebreak the data param
a8c62c2
Change variables in ruby
7d39791
Update src/routes/docs/quick-starts/kotlin/+page.markdoc
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| --- | ||
| layout: article | ||
| title: Start with Deno | ||
| description: Dive into our step-by-step guide on integrating Appwrite with your Deno server backend application. Get your backend up and running quickly with this tutorial. | ||
| difficulty: beginner | ||
| readtime: 5 | ||
| back: /docs/quick-starts | ||
| --- | ||
| Learn how to setup your first Deno project powered by Appwrite. | ||
| {% section #step-1 step=1 title="Create project" %} | ||
| Head to the [Appwrite Console](https://cloud.appwrite.io/console). | ||
|
|
||
| If this is your first time using Appwrite, create an account and create your first project. | ||
|
|
||
| {% only_dark %} | ||
|  | ||
| {% /only_dark %} | ||
| {% only_light %} | ||
|  | ||
| {% /only_light %} | ||
|
|
||
| Then, under **Integrate with your server**, add an **API Key** with the following scopes. | ||
|
|
||
| {% only_dark %} | ||
|  | ||
| {% /only_dark %} | ||
| {% only_light %} | ||
|  | ||
| {% /only_light %} | ||
|
|
||
| | Category {% width=120 %} | Required scopes | Purpose | | ||
| |-----------|-----------------------|---------| | ||
| | Database | `databases.write` | Allows API key to create, update, and delete [databases](/docs/products/databases/databases). | | ||
| | | `collections.write` | Allows API key to create, update, and delete [collections](/docs/products/databases/collections). | | ||
| | | `attributes.write` | Allows API key to create, update, and delete [attributes](/docs/products/databases/collections#attributes). | | ||
| | | `documents.read` | Allows API key to read [documents](/docs/products/databases/documents). | | ||
| | | `documents.write` | Allows API key to create, update, and delete [documents](/docs/products/databases/documents). | | ||
|
|
||
| Other scopes are optional. | ||
|
|
||
| {% /section %} | ||
| {% section #step-2 step=2 title="Create Deno project" %} | ||
| Create a Deno CLI application. | ||
|
|
||
| ```sh | ||
| mkdir my-app | ||
| cd my-app | ||
| echo "console.log('Hello, Deno!');" > mod.ts | ||
| ``` | ||
|
|
||
| {% /section %} | ||
| {% section #step-3 step=3 title="Install Appwrite" %} | ||
|
|
||
| Install the Deno Appwrite SDK by importing it `deno.land/x` at the top of your file. | ||
|
|
||
| ``` | ||
| // import all as sdk | ||
| import * as sdk from "https://deno.land/x/appwrite/mod.ts"; | ||
|
|
||
| // import only what you need | ||
| import { Client, ... other imports } from "https://deno.land/x/appwrite/mod.ts"; | ||
| ``` | ||
|
|
||
| {% /section %} | ||
| {% section #step-4 step=4 title="Import Appwrite" %} | ||
|
|
||
| Find your project ID in the **Settings** page. Also, click on the **View API Keys** button to find the API key that was created earlier. | ||
|
|
||
| {% only_dark %} | ||
|  | ||
| {% /only_dark %} | ||
| {% only_light %} | ||
|  | ||
| {% /only_light %} | ||
|
|
||
| Open `mod.ts` in your IDE and initialize the Appwrite Client. Replace `<YOUR_PROJECT_ID>` with your project ID and `<YOUR_API_KEY>` with your API key. | ||
|
|
||
| ```ts | ||
| import { Client, ID, Databases, Models } from "https://deno.land/x/appwrite/mod.ts"; | ||
|
|
||
| const client: Client = new Client(); | ||
|
|
||
| client | ||
| .setEndpoint("https://cloud.appwrite.io/v1") | ||
| .setProject("<YOUR_PROJECT_ID>") | ||
| .setKey("<YOUR_API_KEY>"); | ||
| ``` | ||
|
|
||
| {% /section %} | ||
| {% section #step-5 step=5 title="Initialize database" %} | ||
|
|
||
| Once the Appwrite Client is initialized, create a function to configure a todo collection. | ||
|
|
||
| ```ts | ||
| const databases: Databases = new Databases(client); | ||
|
|
||
| var todoDatabase: Models.Database; | ||
| var todoCollection: Models.Collection; | ||
|
|
||
| interface Todo { | ||
| title: string; | ||
| description: string; | ||
| isComplete?: boolean; | ||
| } | ||
|
|
||
| async function prepareDatabase(): Promise<void> { | ||
| todoDatabase = await databases.create( | ||
| ID.unique(), | ||
| 'TodosDB' | ||
| ); | ||
|
|
||
| todoCollection = await databases.createCollection( | ||
| todoDatabase.$id, | ||
| ID.unique(), | ||
| 'Todos' | ||
| ); | ||
|
|
||
| await databases.createStringAttribute( | ||
| todoDatabase.$id, | ||
| todoCollection.$id, | ||
| 'title', | ||
| 255, | ||
| true | ||
| ); | ||
|
|
||
| await databases.createStringAttribute( | ||
| todoDatabase.$id, | ||
| todoCollection.$id, | ||
| 'description', | ||
| 255, false, | ||
| 'This is a test description' | ||
| ); | ||
|
|
||
| await databases.createBooleanAttribute( | ||
| todoDatabase.$id, | ||
| todoCollection.$id, | ||
| 'isComplete', | ||
| true | ||
| ); | ||
| } | ||
| ``` | ||
|
|
||
| {% /section %} | ||
| {% section #step-6 step=6 title="Add documents" %} | ||
| Create a function to add some mock data into your new collection. | ||
|
|
||
| ```ts | ||
| async function seedDatabase(): Promise<void> { | ||
| const testTodo1: Todo = { | ||
| title: 'Buy apples', | ||
| description: 'At least 2KGs', | ||
| isComplete: true | ||
| }; | ||
|
|
||
| const testTodo2: Todo = { | ||
| title: 'Wash the apples', | ||
| isComplete: true | ||
| }; | ||
|
|
||
| const testTodo3: Todo = { | ||
| title: 'Cut the apples', | ||
| description: 'Don\'t forget to pack them in a box', | ||
| isComplete: false | ||
| }; | ||
|
|
||
| await databases.createDocument( | ||
| todoDatabase.$id, | ||
| todoCollection.$id, | ||
| ID.unique(), | ||
| testTodo1 | ||
| ); | ||
|
|
||
| await databases.createDocument( | ||
| todoDatabase.$id, | ||
| todoCollection.$id, | ||
| ID.unique(), | ||
| testTodo2 | ||
| ); | ||
|
|
||
| await databases.createDocument( | ||
| todoDatabase.$id, | ||
| todoCollection.$id, | ||
| ID.unique(), | ||
| testTodo3 | ||
| ); | ||
| } | ||
| ``` | ||
|
|
||
| {% /section %} | ||
| {% section #step-7 step=7 title="Retrieve documents" %} | ||
|
|
||
| Create a function to retrieve the mock todo data and a function to execute the requests in order. | ||
| Run the functions to by calling `runAllTasks();`. | ||
|
|
||
| ```ts | ||
| async function getTodos(): Promise<void> { | ||
| const todos = await databases.listDocuments( | ||
| todoDatabase.$id, | ||
| todoCollection.$id | ||
| ); | ||
|
|
||
| todos.documents.forEach((todo: Todo) => { | ||
| console.log(`Title: ${todo.title}\nDescription: ${todo.description}\nIs Todo Complete: ${todo.isComplete}\n\n`); | ||
| }); | ||
| } | ||
|
|
||
| async function runAllTasks(): Promise<void> { | ||
| await prepareDatabase(); | ||
| await seedDatabase(); | ||
| await getTodos(); | ||
| } | ||
| runAllTasks(); | ||
| ``` | ||
|
|
||
| {% /section %} | ||
|
|
||
| {% section #step-8 step=8 title="All set" %} | ||
|
|
||
| Run your project with `deno mod.ts` and view the response in your console. | ||
|
|
||
| {% /section %} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.