beginner
5 min

Start with .NET

Learn how to setup your first .NET project powered by Appwrite.

Create project

Head to the Appwrite Console.

If this is your first time using Appwrite, create an account and create your first project.

Then, under Integrate with your server, add an API Key with the following scopes.

Category	Required scopes	Purpose
Database	databases.write	Allows API key to create, update, and delete databases.
	collections.write	Allows API key to create, update, and delete collections.
	attributes.write	Allows API key to create, update, and delete attributes.
	documents.read	Allows API key to read documents.
	documents.write	Allows API key to create, update, and delete documents.

Other scopes are optional.

Create .NET project

Create a .NET CLI application.

Shell

dotnet new console -o MyApp
cd MyApp

Install Appwrite

Install the .NET Appwrite SDK.

Shell

dotnet add package Appwrite --version 0.13.0

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.

Open the file Program.cs and initialize the Appwrite Client. Replace <PROJECT_ID> with your project ID and <YOUR_API_KEY> with your API key.

using Appwrite;
using Appwrite.Models;
using Appwrite.Services;

var client = new Client();

client
    .SetEndpoint("https://<REGION>.cloud.appwrite.io/v1")
    .SetProject("<PROJECT_ID>")
    .SetKey("<YOUR_API_KEY>");

Initialize database

Once the Appwrite Client is initialized, create a function to configure a todo collection.

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
);

Add documents

Create a function to add some mock data into your new collection.

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
);

Retrieve documents

Create a function to retrieve the mock todo data.

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");
}

All set

Run your project with dotnet run and view the response in your console.

Was this page helpful?

Update on GitHub

Recommended