Start with Angular - Docs

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

Create project

Head to the Appwrite Console.

Create project screen

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.

Add a platform

You can skip optional steps.

Create Angular project

Create an Angular project.

If you don't have Angular CLI installed, run this command.

Shell

npm install -g @angular/cli

Then, create a project.

Shell

ng new my-app
cd my-app

Install Appwrite

Install the JavaScript Appwrite SDK.

Shell

npm install appwrite@18.1.1

Import Appwrite

Find your project's ID in the Settings page.

Project settings screen

Create a new file src/lib/appwrite.ts and add the following code to it, replace <PROJECT_ID> with your project ID.

Web

import { Client, Account} from 'appwrite';

export const client = new Client();

client
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1')
    .setProject('<PROJECT_ID>'); // Replace with your project ID

export const account = new Account(client);
export { ID } from 'appwrite';

Create a login page

First, add imports for the FormsModule from Angular to handle the login form..

TypeScript

import { FormsModule } from '@angular/forms';
...
@NgModule({
  declarations: [
    // ...
  ],
  imports: [
    // ...
    FormsModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Then, replace the contents of src/app/app.component.html.

HTML

<div>
  <p>
    {{ loggedInUser ? 'Logged in as ' + loggedInUser.name : 'Not logged in' }}
  </p>

  <div>
    <input type="email" placeholder="Email" [(ngModel)]="email" />
    <input type="password" placeholder="Password" [(ngModel)]="password" />
    <input type="text" placeholder="Name" [(ngModel)]="name" />

    <button (click)="login(email, password)">
      Login
    </button>

    <button (click)="register(email, password, name)">
      Register
    </button>

    <button (click)="logout()">
      Logout
    </button>
  </div>
</div>

Lastly, update src/app/app.component.ts.

TypeScript

import { Component } from '@angular/core';
import { account, ID } from '../lib/appwrite';
@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})
export class AppComponent {
  loggedInUser: any = null;
  email: string = '';
  password: string = '';
  name: string = '';

  async login(email: string, password: string) {
    await account.createEmailPasswordSession({
      email,
      password
    });
    this.loggedInUser = await account.get();
  }

  async register(email: string, password: string, name: string) {
    await account.create({
      userId: ID.unique(),
      email,
      password,
      name
    });
    this.login(email, password);
  }

  async logout() {
    await account.deleteSession({
      sessionId: 'current'
    });
    this.loggedInUser = null;
  }
}

All set

Run your project with ng serve --port 3000 and open Localhost on Port 3000 in your browser.

Was this page helpful?

Update on GitHub

Recommended