-
Notifications
You must be signed in to change notification settings - Fork 298
Add Python and .NET quickstart #55
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
6 commits
Select commit
Hold shift + click to select a range
aa8ec3d
Add Python quickstart
adityaoberai db8d84e
Create .NET quickstart
adityaoberai cb016b0
update python to follow consistent format
ded3fe6
Add venv setup steps
adityaoberai 0455e10
Merge branch 'feat-docs-g2' into add-node-quickstart
07246a7
Update screenshots with quickstarts server
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,204 @@ | ||
| --- | ||
| layout: article | ||
| title: Start with .NET | ||
| description: This is the description used for SEO. | ||
| --- | ||
| Learn to setup your first .NET 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 create, update, and delete [documents](/docs/products/databases/documents). | | ||
| | | `documents.write` | Allows API key to read [documents](/docs/products/databases/documents). | | ||
|
|
||
| Other scopes are optional. | ||
|
|
||
| {% only_dark %} | ||
|  | ||
| {% /only_dark %} | ||
| {% only_light %} | ||
|  | ||
| {% /only_light %} | ||
|
|
||
| {% /section %} | ||
| {% section #step-2 step=2 title="Create .NET project" %} | ||
| Create a .NET CLI application. | ||
|
|
||
| ```sh | ||
| dotnet new console -o MyApp | ||
| cd MyApp | ||
| ``` | ||
|
|
||
| {% /section %} | ||
| {% section #step-3 step=3 title="Install Appwrite" %} | ||
|
|
||
| Install the .NET Appwrite SDK. | ||
|
|
||
| ```sh | ||
| dotnet add package Appwrite | ||
| ``` | ||
| {% /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 the file `Program.cs` and initialize the Appwrite Client. Replace `<YOUR_PROJECT_ID>` with your project ID and `<YOUR_API_KEY>` with your API key. | ||
|
|
||
| ```csharp | ||
| using Appwrite; | ||
| using Appwrite.Models; | ||
| using Appwrite.Services; | ||
|
|
||
| var 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. | ||
|
|
||
| ```csharp | ||
| var databases = new Databases(client); | ||
|
|
||
| Database todoDatabase; | ||
| Collection todoCollection; | ||
|
|
||
| todoDatabase = await databases.Create( | ||
| databaseId: ID.Unique(), | ||
| name: "TodosDB" | ||
| ); | ||
|
|
||
| todoCollection = await databases.CreateCollection( | ||
| databaseId: todoDatabase.Id, | ||
| collectionId: ID.Unique(), | ||
| name: "Todos" | ||
| ); | ||
|
|
||
| await databases.CreateStringAttribute( | ||
| databaseId: todoDatabase.Id, | ||
| collectionId: todoCollection.Id, | ||
| key: "title", | ||
| size: 255, | ||
| required: true | ||
| ); | ||
|
|
||
| await databases.CreateStringAttribute( | ||
| databaseId: todoDatabase.Id, | ||
| collectionId: todoCollection.Id, | ||
| key: "description", | ||
| size: 255, | ||
| required: false, | ||
| xdefault: "This is a test description" | ||
| ); | ||
|
|
||
| await databases.CreateBooleanAttribute( | ||
| databaseId: todoDatabase.Id, | ||
| collectionId: todoCollection.Id, | ||
| key: "isComplete", | ||
| required: true | ||
| ); | ||
| ``` | ||
|
|
||
| {% /section %} | ||
| {% section #step-6 step=6 title="Add documents" %} | ||
| Create a function to add some mock data into your new collection. | ||
| ```csharp | ||
| var testTodo1 = new Dictionary<string, object>() | ||
| { | ||
| {"title", "Buy apples"}, | ||
| {"description", "At least 2KGs"}, | ||
| {"isComplete", true} | ||
| }; | ||
|
|
||
| var testTodo2 = new Dictionary<string, object>() | ||
| { | ||
| {"title", "Wash the apples"}, | ||
| {"isComplete", true} | ||
| }; | ||
|
|
||
| var testTodo3 = new Dictionary<string, object>() | ||
| { | ||
| {"title", "Cut the apples"}, | ||
| {"description", "Don't forget to pack them in a box"}, | ||
| {"isComplete", false} | ||
| }; | ||
|
|
||
| await databases.CreateDocument( | ||
| databaseId: todoDatabase.Id, | ||
| collectionId: todoCollection.Id, | ||
| documentId: ID.Unique(), | ||
| data: testTodo1 | ||
| ); | ||
|
|
||
| await databases.CreateDocument( | ||
| databaseId: todoDatabase.Id, | ||
| collectionId: todoCollection.Id, | ||
| documentId: ID.Unique(), | ||
| data: testTodo2 | ||
| ); | ||
|
|
||
| await databases.CreateDocument( | ||
| databaseId: todoDatabase.Id, | ||
| collectionId: todoCollection.Id, | ||
| documentId: ID.Unique(), | ||
| data: testTodo3 | ||
| ); | ||
| ``` | ||
|
|
||
| {% /section %} | ||
| {% section #step-7 step=7 title="Retrieve documents" %} | ||
|
|
||
| Create a function to retrieve the mock todo data. | ||
|
|
||
| ```csharp | ||
| var todos = await databases.ListDocuments( | ||
| databaseId: todoDatabase.Id, | ||
| collectionId: todoCollection.Id | ||
| ); | ||
|
|
||
| foreach (var todo in todos.Documents) | ||
| { | ||
| Console.WriteLine($"Title: {todo.Data["title"]}\nDescription: {todo.Data["description"]}\nIs Todo Complete: {todo.Data["isComplete"]}\n\n"); | ||
| } | ||
| ``` | ||
|
|
||
| {% /section %} | ||
|
|
||
| {% section #step-8 step=8 title="All set" %} | ||
|
|
||
| Run your project with `dotnet run` 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.