Security is principally concerned with verifying identities. A typical example is logging into an application using an email or password, thus allowing the system to confirm that the entered credentials match the database's credentials.
Appwrite Cloud is an extension of the open-source version of Appwrite. It comes with all the services included in the open-source version but now with a fully managed service and minimum friction.
This post discusses safeguarding user profiles using Appwrite Cloud’s out-of-the-box functionalities.
GitHub
The project’s GitHub repository can be found here.
Prerequisites
To follow along with this tutorial, you should have a working knowledge of the following:
- Vue, Nuxt.js, and CSS
- An Appwrite cloud account
You can request access to Appwrite Cloud here.
Setting up the project
You need to create a Nuxt.js starter project by navigating to the desired directory and running the command below in your terminal.
npx nuxi@latest init appwrite-auth
The command creates a Nuxt.js project called appwrite-auth .
Next, you need to install Nuxt.js dependencies by running the command below in your terminal.
npm install
Next, go to the project directory and start the development server on localhost:3000 with the commands below.
cd appwrite-auth && npm run dev
Installing dependencies
Installing Pink Design
Pink Design is an open-source system from Appwrite used to build consistent and reusable user interfaces. It enhances collaboration, development experience, and accessibility.
To install Pink Design, open the terminal in the project directory and run the following command
npm install @appwrite.io/pink
To use Pink Design in your project, import it into your project’s files like this:
import '@appwrite.io/pink';
import '@appwrite.io/pink-icons';
Installing Appwrite
Appwrite is a development platform that provides a powerful API and management console for building backend servers for web and mobile applications. To install it, run the command below:
npm install appwrite
Creating an Appwrite Cloud project
To get started, log into your Appwrite cloud, click the Create project button, input appwrite-nuth-auth as the name, and then click Create.
The project dashboard will appear on the console. Next, copy the Project ID you’ll use this to set up your Next.js application.
Creating an Auth user
On the left side of the Appwrite Cloud dashboard, click on the Auth tab.
Click the Create user button to fill in the User form with the necessary information.
After applying the necessary configurations on Appwrite, let’s start building the application.
Integrating Appwrite Cloud into the Nuxt.js project
To integrate Appwrite into the UI, create a utils/web-init.js file. The file should look like this.
import { Client, Account } from "appwrite";
export const client = new Client();
export const account = new Account(client);
client
.setEndpoint("https://cloud.appwrite.io/v1")
.setProject("643fee63b2b5b506495c");
The code above does:
- Import the module
ClientandAccountfrom appwrite - Instantiates the
ClientandAccountobjects - Uses the client object to set the endpoint and project
Creating the signup page
Let’s create a signup page where people who will later be assigned roles to perform certain operations within the database can generically create an account. To do this, you will create a components/Sign-up.vue and add the code below:
<template>
<section>
<div
class="card u-cross-center u-width-full-line u-max-width-400"
style="margin: 40px auto"
>
<form
method="post"
@submit.prevent="signUp"
class="form u-margin-block-start-24"
>
<ul class="form-list">
<li class="form-item">
<label class="label">Email</label>
<div class="input-text-wrapper">
<input
type="email"
class="input-text u-padding-inline-end-56"
placeholder="email address"
name="email"
v-model.lazy="email"
/>
</div>
</li>
<li class="form-item">
<label class="label">Password</label>
<div class="input-text-wrapper">
<input
type="password"
class="input"
placeholder="password"
name="password"
v-model.lazy="password"
/>
</div>
</li>
<li class="form-item">
<label class="label">Confirm Password</label>
<div class="input-text-wrapper">
<input
type="password"
class="input"
placeholder="password"
name="password"
v-model.lazy="confirmPassword"
/>
</div>
</li>
</ul>
<div class="form-footer">
<div class="u-flex u-main-end u-gap-12">
<button class="button" type="submit">Signup</button>
</div>
</div>
</form>
</div>
</section>
</template>
<script>
import "@appwrite.io/pink"; // optionally, add icons import "@appwrite.io/pink-icons";
</script>
The code block above achieves the following:
- Imports the Appwrite Pink Design for styling
- Created a form to accept email, password, and confirm password for users to sign up
Adding the signup functionality
Your interface will need to be connected to Appwrite to authenticate users. You will add the following code in the <script> tag of your components/Signup.vue file to do this.
<script lang="ts">
import "@appwrite.io/pink";
import "@appwrite.io/pink-icons";
import { account, client } from "~/utils/web-init";
export default {
data: () => ({
name: "",
email: "",
password: "",
confirmPassword: "",
}),
methods: {
signUp: async function () {
if (this.password.length >= 8) {
if (this.password === this.confirmPassword) {
try {
await account.create(
"unique()",
this.email,
this.password,
this.name
);
alert("account created successfully");
window.location.href = "/signin";
} catch (e) {
console.log(e);
}
} else {
alert("password do not match");
}
} else {
alert("password length should be up to 8 characters");
}
},
},
};
</script>
The code block above achieves the following:
- Imports the Appwrite SDK initialized in the
utils/web-init.jsfile - Creates the
signUpfunction in themethodsproperty, which performs the following functions: - Verifies that the password length is equal to or greater than eight characters
- Confirms that the characters in
passwordandconfirmPasswordare the same - Accesses Appwrite's services using the
account.createto create a new account using the user's email, password, and name - To use Appwrite's create account service, it's mandatory to add the
userId; in this case,uniqueIdwas used to generate one automatically - Adding
emailandpasswordis also mandatory - The
nameoption is optional; you can create an account without one -
window.location.hrefallowed us to navigate to the insight interface after successful account creation
Next, import the components/Sign-up.vue into the pages/index.vue, like so:
<template>
<section class="u-text-center" style="margin: 50px auto;">
<h1 class="u-font-size-32 u-text-center">Nuxt Authentication app</h1>
<div class="u-cross-center">
<Signup/>
</div>
</section>
</template>
<script>
import "@appwrite.io/pink"; // optionally, add icons
import "@appwrite.io/pink-icons";
</script>
At this point, your signup page should look like the below:
Creating the sign-in interface
You also need to create a sign-in page that allows registered users to log in to the dashboard. To do this, you will create a pages/Signin.vue and add the code below:
<template>
<section>
<div
class="card u-cross-center u-width-full-line u-max-width-400"
style="margin: 100px auto"
>
<div class="u-flex u-main-space-between u-cross-center">
<h6 class="heading-level-6">Welcome back!</h6>
<button class="icon-x"></button>
</div>
<form
method="post"
@submit.prevent="signIn"
class="form u-margin-block-start-24"
>
<ul class="form-list">
<li class="form-item">
<label class="label">Email</label>
<div class="input-text-wrapper">
<input
type="email"
class="input-text u-padding-inline-end-56"
placeholder="email address"
name="email"
v-model.lazy="email"
/>
</div>
</li>
<li class="form-item">
<label class="label">Password</label>
<div class="input-text-wrapper">
<input
type="password"
class="input"
placeholder="password"
name="password"
v-model.lazy="password"
/>
</div>
</li>
</ul>
<div class="form-footer">
<div class="u-flex u-main-end u-gap-12">
<button class="button" type="submit" @click="updateData">
Login
</button>
</div>
</div>
</form>
</div>
</section>
</template>
<script>
import "@appwrite.io/pink";
import "@appwrite.io/pink-icons";
import {account, client} from '~/utils/web-init'
export default {
data() {
return {
email: "",
password: "",
};
},
methods: {
signIn: async function () {
try {
await account.createEmailSession(
this.email,
this.password
);
alert("user signed in");
this.$router.push({ path: `/profile` });
} catch (e) {
console.log(e);
}
},
},
};
</script>
The code snippet above does the following:
- Imported the Appwrite SDK initialized in the
utils/web-init.jsfile - Created a form to accept a valid email and password combination
- Created a function called
signInthat does the following: - Accesses Appwrite's services using the
account.createEmailSessionto create a new account session using the user's email and password -
this.$router.pushallows you to navigate to the profile interface after successful user login
After applying the configurations, the application will look like this:
Creating the profile page
The profile page is displayed when the user has been authenticated. Create a new profile.vue file inside the pages directory and paste the code below in it:
<template>
<article class="card u-text-center">
<img
class="avatar is-size-x-large u-margin-inline-auto"
src="https://source.unsplash.com/LaK153ghdig/132x132"
alt="Kristin Watson"
width="66"
height="66"
/>
<h3 class="body-text-2 u-margin-block-start-16">Kristin Watson</h3>
<p class="u-margin-block-start-4 u-color-text-gray">kristin.watson@appwrite.io</p>
<button class="button u-margin-inline-auto u-margin-block-start-24">
<span class="text">Edit profile</span>
</button>
</article>
</template>
At this point, your application should look like this:
Conclusion
This article discussed using Appwrite Cloud’s security management system and protocol to safeguard user profiles integrated into Nuxt 3 app.
Top comments (0)