Quick Start with Appwrite

Learn how to add Appwrite to your web apps.

Head to the Appwrite Console.

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

Then, under Add a platform, add a Web app. The Hostname should be localhost or the domain on which you're hosting your web app.

Cross-Origin Resource Sharing (CORS)

Adding localhost as a platform lets your local app talk to Appwrite. For production, add your live domain to avoid CORS errors.

Learn more in our CORS error guide.

You can skip optional steps.

You can install the Appwrite Web SDK using a package manager.

You can also add the Appwrite Web SDK using CDN by adding a script tag to your HTML file. The SDK will be available globally through the Appwrite namespace.

If you installed via npm, you can import Client and Account from the Appwrite SDK.

If you're using CDN, the library loads directly in your browser as a global object, so you access it through Appwrite instead of imports.

If you prefer TypeScript, you can import TypeScript models from the Appwrite SDK.

Sometimes you'll need to extend TypeScript models with your own type definitions.

For example, when you fetch a list of rows from a table, you can define the expected structure of the rows like this.

When you fetch rows, you can use this new Idea interface like this.

The Appwrite SDK works with your favorite Web frameworks.

Learn to use Appwrite by adding authentication to a simple web app.

Learn to use Appwrite by building an idea tracker app.

Type safety with TypeScript

For better type safety in TypeScript projects, define interfaces and use generics:

Generate types automatically

Use the Appwrite CLI to generate TypeScript interfaces automatically: appwrite types ./types

Recommended