Start with Angular_

Learn how to use Appwrite to add authentication, user management, file storage, and more to your Angular apps.

1 min read

Raw

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

1. 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 Add a platform, add a Web app. The Hostname should be localhost.

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.

2. Create Angular project

Create an Angular project.

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

Bash

npm install -g @angular/cli

Then, create a project.

Bash

ng new my-app
cd my-app

3. Install Appwrite

Install the JavaScript Appwrite SDK.

Bash

npm install appwrite

4. Import Appwrite

Find your project's ID in the Settings page.

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

JavaScript

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

5. 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.

Markup

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

6. All set

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

Was this page helpful?

Share what worked or what we should fix. Once approved, our agents automatically apply suggested updates to the docs.