implement user authentication with auth0

Author: byron-okta

NOTICE

@@ -1,45 +1,13 @@
-# Vue/JavaScript: Starter SPA Code Sample
+# Vue/JavaScript: Basic User Authentication Code Sample
 
-This JavaScript code sample demonstrates how to build a Single-Page Application (SPA) using Vue. This Vue code sample builds the API server using the Vue Composition API.
+This JavaScript code sample demonstrates **how to implement user authentication** in Vue applications using Auth0. This Vue code sample builds the Single-Page Application (SPA) using the Vue Composition API.
 
-Visit the ["Vue/JavaScript Code Samples: SPA Security in Action"](https://developer.auth0.com/resources/code-samples/spa/vue) section of the ["Auth0 Developer Resources"](https://developer.auth0.com/resources) to explore how you can secure Vue applications written in JavaScript by implementing endpoint protection and authorization with Auth0.
+This code sample is part of the ["Auth0 Developer Resources"](https://developer.auth0.com/resources), a place where you can explore the authentication and authorization features of the Auth0 Identity Platform.
 
-[![Vue/JavaScript Code Samples: SPA Security in Action](https://cdn.auth0.com/blog/hub/code-samples/spa/vue-javascript.png)](https://developer.auth0.com/resources/code-samples/spa/vue)
+Visit the ["Vue/JavaScript + Composition API Code Sample: User Authentication For Basic Apps"](https://developer.auth0.com/resources/code-samples/spa/vue/basic-authentication) page for instructions on how to configure and run this code sample and how to integrate it with an API server of your choice to [create a full-stack code sample](https://developer.auth0.com/resources/code-samples/full-stack/hello-world/basic-access-control/spa).
+
+[![Vue/JavaScript + Composition API Code Sample: User Authentication For Basic Apps](https://cdn.auth0.com/blog/hub/code-samples/spa/vue-javascript/basic-authentication-with-composition-api.png)](https://developer.auth0.com/resources/code-samples/spa/vue/basic-authentication)
 
 ## Why Use Auth0?
 
 Auth0 is a flexible drop-in solution to add authentication and authorization services to your applications. Your team and organization can avoid the cost, time, and risk that come with building your own solution to authenticate and authorize users. We offer tons of guidance and SDKs for you to get started and [integrate Auth0 into your stack easily](https://developer.auth0.com/resources/code-samples/full-stack).
-
-## Set Up and Run the Vue Project
-
-Install the project dependencies:
-
-```bash
-npm install
-```
-
-The starter Vue project offers a functional application that consumes data from an external API to hydrate the user interface. For simplicity and convenience, the starter project simulates the external API locally using [`json-server`](https://github.com/typicode/json-server).
-
-However, you can also integrate this starter project with any of the ["Hello World" API code samples, which are available in multiple backend frameworks and programming languages](https://github.com/orgs/auth0-developer-hub/repositories?language=&q=api+hello-world&sort=&type=public).
-
-The compatible API server runs on `http://localhost:6060` by default. As such, to connect your Vue application with that API server, create a `.env` file under the root project directory and populate it with the following environment variables:
-
-```bash
-VITE_API_SERVER_URL=http://localhost:6060
-```
-
-Next, execute the following command to run the JSON server API:
-
-```bash
-npm run api
-```
-
-Finally, open another terminal tab and execute this command to run your Vue application:
-
-```bash
-npm run dev
-```
-
-Visit [`http://localhost:4040/`](http://localhost:4040/) to access the starter application.
-
-In the starter project, all the starter Vue application routes are public. However, you can use Auth0 to get an ID token to hydrate the user profile information present on the `/profile` page with information from a real user. With Auth0, you can also get an access token to make a secure call to an external API to hydrate the messages present in the `/protected` and `/admin` pages.

README.md

@@ -9,6 +9,7 @@
     "api": "json-server --host 0.0.0.0 --port 6060 --watch json-server/db.json --routes json-server/routes.json"
   },
   "dependencies": {
+    "@auth0/auth0-vue": "^2.0.0",
     "axios": "^0.27.2",
     "vue": "^3.2.36",
     "vue-router": "^4.0.15"

package-lock.json

@@ -1,3 +1,13 @@
 <template>
-  <router-view />
+  <div v-if="isLoading" class="page-layout">
+    <PageLoader />
+  </div>
+  <router-view v-else />
 </template>
+
+<script setup>
+import PageLoader from "@/components/page-loader.vue";
+import { useAuth0 } from "@auth0/auth0-vue";
+
+const { isLoading } = useAuth0();
+</script>

package.json

@@ -0,0 +1,20 @@
+<template>
+  <button class="button__login" @click="handleLogin">Log In</button>
+</template>
+
+<script setup>
+import { useAuth0 } from "@auth0/auth0-vue";
+
+const { loginWithRedirect } = useAuth0();
+
+const handleLogin = () => {
+  loginWithRedirect({
+    appState: {
+      target: "/profile",
+    },
+    authorizationParams: {
+      prompt: "login",
+    }
+  });
+};
+</script>

src/app.vue

@@ -0,0 +1,16 @@
+<template>
+  <button class="button__logout" @click="handleLogout">Log Out</button>
+</template>
+
+<script setup>
+import { useAuth0 } from "@auth0/auth0-vue";
+
+const { logout } = useAuth0();
+
+const handleLogout = () =>
+  logout({
+    logoutParams: {
+      returnTo: window.location.origin,
+    }
+  });
+</script>

src/components/buttons/login-button.vue

@@ -0,0 +1,21 @@
+<template>
+  <button class="button__sign-up" @click="handleSignUp">Sign Up</button>
+</template>
+
+<script setup>
+import { useAuth0 } from "@auth0/auth0-vue";
+
+const { loginWithRedirect } = useAuth0();
+
+const handleSignUp = () => {
+  loginWithRedirect({
+    appState: {
+      target: "/profile",
+    },
+    authorizationParams: {
+      prompt: "login",
+      screen_hint: "signup",
+    }
+  });
+};
+</script>

src/components/buttons/logout-button.vue

@@ -1,3 +1,20 @@
 <template>
-  <div />
+  <div class="nav-bar__buttons">
+    <template v-if="!isAuthenticated">
+      <SignupButton />
+      <LoginButton />
+    </template>
+    <template v-if="isAuthenticated">
+      <LogoutButton />
+    </template>
+  </div>
 </template>
+
+<script setup>
+import LoginButton from "@/components/buttons/login-button.vue";
+import LogoutButton from "@/components/buttons/logout-button.vue";
+import SignupButton from "@/components/buttons/signup-button.vue";
+import { useAuth0 } from "@auth0/auth0-vue";
+
+const { isAuthenticated } = useAuth0();
+</script>

src/components/buttons/signup-button.vue

@@ -2,11 +2,16 @@
   <div class="nav-bar__tabs">
     <NavBarTab path="/profile" label="Profile" />
     <NavBarTab path="/public" label="Public" />
-    <NavBarTab path="/protected" label="Protected" />
-    <NavBarTab path="/admin" label="Admin" />
+    <template v-if="isAuthenticated">
+      <NavBarTab path="/protected" label="Protected" />
+      <NavBarTab path="/admin" label="Admin" />
+    </template>
   </div>
 </template>
 
 <script setup>
 import NavBarTab from "@/components/navigation/desktop/nav-bar-tab.vue";
+import { useAuth0 } from "@auth0/auth0-vue";
+
+const { isAuthenticated } = useAuth0();
 </script>