spa

Vue.js

In this quickstart you are going to build an application with Vue.js and integrate it with FusionAuth. You’ll be building it for ChangeBank, a global leader in converting dollars into coins. It’ll have areas reserved for users who have logged in as well as public facing sections.

The docker compose file and source code for a complete application are available at https://github.com/FusionAuth/fusionauth-quickstart-javascript-vue-web

Prerequisites

Node v18: This will be used to run the Vue.js application.
Docker: The quickest way to stand up FusionAuth. (There are other ways).

This app has been tested with Node v18 and Vue.js v3.3.4. This example should work with other compatible versions of Node and Vue.js.

General Architecture

While this sample application doesn’t have login functionality without FusionAuth, a more typical integration will replace an existing login system with FusionAuth.

In that case, the system might look like this before FusionAuth is introduced.

Request flow during login before FusionAuth

The login flow will look like this after FusionAuth is introduced.

Request flow during login after FusionAuth

In general, you are introducing FusionAuth in order to normalize and consolidate user data. This helps make sure it is consistent and up-to-date as well as offloading your login security and functionality to FusionAuth.

Getting Started

In this section, you’ll get FusionAuth up and running and use Vue.js CLI to create a new application.

Clone The Code

First off, grab the code from the repository and change into that directory.

git clone https://github.com/FusionAuth/fusionauth-quickstart-javascript-vue-web.git
cd fusionauth-quickstart-javascript-vue-web

Run FusionAuth Via Docker

In the root directory of the repo you’ll find a Docker compose file (docker-compose.yml) and an environment variables configuration file (.env). Assuming you have Docker installed on your machine, you can stand up FusionAuth up on your machine with:

docker compose up -d

This will start three containers, once each for FusionAuth, Postgres, and Elastic.

Here you are using a bootstrapping feature of FusionAuth, called Kickstart. When FusionAuth comes up for the first time, it will look at the kickstart/kickstart.json file and configure FusionAuth to a certain initial state.

If you ever want to reset the FusionAuth system, delete the volumes created by docker-compose by executing docker compose down -v, then re-run docker compose up -d.

FusionAuth will be configured with these settings:

Your client Id is e9fdb985-9173-4e01-9d73-ac2d60d1dc8e.
Your client secret is super-secret-secret-that-should-be-regenerated-for-production.
Your example username is richard@example.com and the password is password.
Your admin username is admin@example.com and the password is password.
The base URL of FusionAuth http://localhost:9011/.

You can log into the FusionAuth admin UI and look around if you want, but with Docker/Kickstart you don’t need to.

Create A Basic Vue.js Application

Now you are going to create a basic Vue.js application using Create Vue. While this section builds a simple Vue.js application, you can use the same configuration to integrate your existing Vue.js application with FusionAuth.

npm create vue@latest -- changebank --typescript --router

We are going to use the Hosted Backend feature of FusionAuth, so you don’t need to worry about setting up a backend server.

First, install the FusionAuth Vue SDK:

npm install @fusionauth/vue-sdk

Next, you’ll need to configure and activate the FusionAuth Vue SDK. You can do this by updating the src/main.ts file contents. Replace what is there with this:

import './assets/main.css'
import '@fusionauth/vue-sdk/dist/style.css';

import {createApp} from 'vue'
import App from './App.vue'
import router from './router'
import FusionAuthVuePlugin from '@fusionauth/vue-sdk';

const app = createApp(App)

app.use(FusionAuthVuePlugin, {
  clientId: 'e9fdb985-9173-4e01-9d73-ac2d60d1dc8e',
  serverUrl: 'http://localhost:9011',
  redirectUri: 'http://localhost:5173',
});

app.use(router)

app.mount('#app')

Our example application is going to have a home page, an account page and a page where someone can make change. The account and make change page will be protected and only visible to logged in users.

Create A Home Page

The next step is to get a basic home page up and running. We’ll take this opportunity to copy in all the images and CSS style files that you’ll need for the application.

Run the following copy command to copy these files from the quickstart repo into your project. This assumes that you checked the quickstart repo out into the parent directory. If that’s not the case, replace the .. below with your actual repo location.

cp -r ../complete-application/src/assets src

The home page will be a simple page with a welcome message and a login link. Replace the content of the file src/views/HomeView.vue:

<template>
  <div class="column-container">
    <div class="content-container">
      <div style="margin-bottom: 100px;">
        <h1>Welcome to Changebank</h1>
        <p>To get started, <a style="cursor: pointer">log in or create a new account</a>.</p>
      </div>
    </div>

    <div style="flex: 0">
      <img src="@/assets/money.jpg" style="max-width: 800px;" alt=""/>
    </div>
  </div>
</template>

Create An Account Page

The account page displays a random balance for the logged in user. Create a new file src/views/AccountView.vue:

<template>
  <div class="column-container">
    <div class="app-container">
      <h3>Your balance</h3>
      <div class="balance">{{ balance }}</div>
    </div>
  </div>
</template>

<script setup lang="ts">
let dollarUS = Intl.NumberFormat("en-US", {
  style: "currency",
  currency: "USD",
  useGrouping: false,
});
const balance = dollarUS.format(Math.ceil(Math.random() * 100000) / 100);
</script>

Create A Make Change Page

Next, you’ll create a page only visible to logged in users. This page displays an input field for the user to enter a dollar amount and a button to convert that amount into coins. Create a new file src/views/MakeChangeView.vue:

<template>
  <div class="app-container change-container">
    <h3>We Make Change</h3>

    <div class="change-message" v-if="change">
      We can make change for {{ dollarUS.format(change.total) }} with {{ change.nickels }} nickels and {{ change.pennies }} pennies!
    </div>

    <form @submit="makeChange">
      <div class="h-row">
        <div class="change-label">Amount in USD: $</div>
        <input class="change-input" name="amount" type="number" step=".01" v-model="amount"/>
        <input class="change-submit" type="submit" value="Make Change"/>
      </div>
    </form>
  </div>
</template>

<script setup lang="ts">
import {ref} from "vue";

const amount = ref<number>(0);
const change = ref<{ total: number; nickels: number; pennies: number } | null>();

let dollarUS = Intl.NumberFormat("en-US", {
  style: "currency",
  currency: "USD",
  useGrouping: false,
});

const makeChange = (e: Event) => {
  e.stopPropagation();
  e.preventDefault();

  const total = amount.value;
  const nickels = Math.floor(amount.value / 0.05);
  const pennies = Math.round((amount.value - nickels * 0.05) * 100);
  change.value = {total, nickels, pennies};
};
</script>

Authentication

You now have created a basic Vue.js application with a home page, account page and a page for making change.

Depending on the user’s authentication state, the login or logout button should be displayed in the header. For this create a new file src/components/LogoHeader.vue:

<template>
  <div id="logo-header">
    <img src="@/assets/changebank.svg" alt="Change Bank" width="257" height="55"/>

    <RequireAuth>
      <div class="h-row">
        <p class="header-email" v-if="userInfo">
          {{ userInfo.email }}
        </p>
        <a class="button-lg" style="cursor: pointer" @click="fusionAuth.logout()">Logout</a>
      </div>
    </RequireAuth>

    <RequireAnonymous>
      <a class="button-lg" style="cursor: pointer" @click="fusionAuth.login()">Login</a>
    </RequireAnonymous>

  </div>
</template>

<script setup lang="ts">
import {useFusionAuth, type UserInfo} from "@fusionauth/vue-sdk";
import {onMounted, ref} from "vue";

const userInfo = ref<UserInfo | null>(null);

const fusionAuth = useFusionAuth();

onMounted(async () => {
  userInfo.value = await fusionAuth.getUserInfo();
});
</script>

Additionally, we want to display different menu items. For this create a new file src/components/MenuBar.vue:

<template>
  <div id="menu-bar" class="menu-bar">
    <RequireAuth>
      <router-link to="/make-change" class="menu-link" active-class="active">Make Change</router-link>
      <router-link to="/account" class="menu-link" active-class="active">Account</router-link>
    </RequireAuth>

    <RequireAnonymous>
      <a class="menu-link">About</a>
      <a class="menu-link">Services</a>
      <a class="menu-link">Products</a>

      <a class="menu-link" style="text-decoration: underline">Home</a>
    </RequireAnonymous>
  </div>
</template>

The next step is to tie it all together. Update the src/App.vue file to add the router view and header. You can replace the contents of the file with the below:

<script setup lang="ts">
import {RouterView} from 'vue-router'
import MenuBar from "@/components/MenuBar.vue";
import LogoHeader from "@/components/LogoHeader.vue";
</script>

<template>
  <div id="page-container">
    <div id="page-header">
      <LogoHeader/>
      <MenuBar/>
    </div>

    <div style="flex: 1">
      <RouterView/>
    </div>
  </div>
</template>

And finally we register the routes in src/router/index.ts. Update that file with the code below.

import {createRouter, createWebHistory} from 'vue-router'
import HomeView from '../views/HomeView.vue'
import {useFusionAuth} from "@fusionauth/vue-sdk";

const routeGuard = (loggedIn: boolean, fallback: string) => {
  return () => {
    const fusionAuth = useFusionAuth();
    if (fusionAuth.isLoggedIn() !== loggedIn) {
      return fallback;
    }
  }
}

const router = createRouter({
  history: createWebHistory(import.meta.env.BASE_URL),
  routes: [
    {
      path: '/',
      name: 'home',
      component: HomeView,
      beforeEnter: routeGuard(false, '/account')
    },
    {
      path: '/account',
      name: 'account',
      component: () => import('../views/AccountView.vue'),
      beforeEnter: routeGuard(true, '/')
    },
    {
      path: '/make-change',
      name: 'make-change',
      component: () => import('../views/MakeChangeView.vue'),
      beforeEnter: routeGuard(true, '/')
    },
    {path: '/:pathMatch(.*)*', redirect: '/'},
  ]
})

export default router

Running The Application

You can now run the application with the following command:

npm run dev

You can now open up an incognito window and navigate to http://localhost:5173. You will be greeted with the home page. Log in with the user account you created when setting up FusionAuth, and you’ll be redirected to the account page.

The username and password of the example user can be found in the FusionAuth via Docker section at the top of this article.

Next Steps

This quickstart is a great way to get a proof of concept up and running quickly, but to run your application in production, there are some things you’re going to want to do.

FusionAuth Customization

FusionAuth gives you the ability to customize just about everything with the user’s experience and your application’s integration. This includes

Hosted pages such as login, registration, email verification, and many more
Email templates
User data and custom claims in access token JWTs

Security

You may want to customize the token expiration times and policies in FusionAuth
Choose password rules and a hashing algorithm that meet your security needs

Tenant And Application Management

Model your application topology using Applications, Roles, Groups, Entities, and more
Set up MFA, Social login, and/or SAML integrations
Integrate with external systems using Webhooks, SCIM, and Lambdas

Results

Recent