Learn how to setup your first Node.js project powered by Appwrite.
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. |
tables.write | Allows API key to create, update, and delete tables. | |
columns.write | Allows API key to create, update, and delete columns. | |
rows.read | Allows API key to read rows. | |
rows.write | Allows API key to create, update, and delete rows. |
Other scopes are optional.
Create a Node.js CLI application.
mkdir my-app
cd my-app
npm init
Install the Node.js Appwrite SDK.
npm install node-appwrite@17.0.0
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.


Create a new file app.js
and initialize the Appwrite Client. Replace <PROJECT_ID>
with your project ID and <YOUR_API_KEY>
with your API key.
const sdk = require("node-appwrite");
const client = new sdk.Client();
client
.setEndpoint("https://<REGION>.cloud.appwrite.io/v1")
.setProject("<PROJECT_ID>")
.setKey("<YOUR_API_KEY>");
Once the Appwrite Client is initialized, create a function to configure a todo table.
const tablesDB = new sdk.TablesDB(client);
var todoDatabase;
var todoTable;
async function prepareDatabase() {
todoDatabase = await tablesDB.create({
databaseId: sdk.ID.unique(),
name: 'TodosDB'
});
todoTable = await tablesDB.createTable({
databaseId: todoDatabase.$id,
tableId: sdk.ID.unique(),
name: 'Todos'
});
await tablesDB.createStringAttribute({
databaseId: todoDatabase.$id,
collectionId: todoCollection.$id,
key: 'title',
size: 255,
required: true
});
await tablesDB.createStringColumn(
todoDatabase.$id,
todoTable.$id,
'title',
255,
true
);
await tablesDB.createStringColumn(
todoDatabase.$id,
todoTable.$id,
'description',
255, false,
'This is a test description'
);
await tablesDB.createBooleanColumn(
todoDatabase.$id,
todoTable.$id,
'isComplete',
true
);
}
Create a function to add some mock data into your new table.
async function seedDatabase() {
var testTodo1 = {
title: 'Buy apples',
description: 'At least 2KGs',
isComplete: true
};
var testTodo2 = {
title: 'Wash the apples',
isComplete: true
};
var testTodo3 = {
title: 'Cut the apples',
description: 'Don\'t forget to pack them in a box',
isComplete: false
};
await tablesDB.createRow({
databaseId: todoDatabase.$id,
tableId: todoTable.$id,
rowId: sdk.ID.unique(),
data: testTodo1
});
await tablesDB.createRow({
databaseId: todoDatabase.$id,
tableId: todoTable.$id,
rowId: sdk.ID.unique(),
data: testTodo2
});
await tablesDB.createRow({
databaseId: todoDatabase.$id,
tableId: todoTable.$id,
rowId: sdk.ID.unique(),
data: testTodo3
});
}
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();
.
async function getTodos() {
var todos = await tablesDB.listRows({
databaseId: todoDatabase.$id,
tableId: todoTable.$id
});
todos.rows.forEach(todo => {
console.log(`Title: ${todo.title}\nDescription: ${todo.description}\nIs Todo Complete: ${todo.isComplete}\n\n`);
});
}
async function runAllTasks() {
await prepareDatabase();
await seedDatabase();
await getTodos();
}
runAllTasks();
Run your project with node app.js
and view the response in your console.