beginner
5 min

Start with Deno

Learn how to setup your first Deno 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 Deno project

Create a Deno CLI application.

Shell

mkdir my-app
cd my-app
echo "console.log('Hello, Deno!');" > mod.ts

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@10.0.1/mod.ts";

// import only what you need
import { Client, ... other imports } from "https://deno.land/x/appwrite/mod.ts";

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 mod.ts in your IDE and initialize the Appwrite Client. Replace <PROJECT_ID> with your project ID and <YOUR_API_KEY> with your API key.

TypeScript

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("<PROJECT_ID>")
    .setKey("<YOUR_API_KEY>");

Initialize database

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

TypeScript

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

Add documents

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

TypeScript

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

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

TypeScript

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

All set

Run your project with deno mod.ts and view the response in your console.

Was this page helpful?

Update on GitHub

Recommended