Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stytchauth/stytch-vue-example
A Vue.js example app using the Stytch JavaScript SDK
https://github.com/stytchauth/stytch-vue-example
authentication stytch vue vue3
Last synced: 3 months ago
JSON representation
A Vue.js example app using the Stytch JavaScript SDK
- Host: GitHub
- URL: https://github.com/stytchauth/stytch-vue-example
- Owner: stytchauth
- Created: 2023-03-09T18:22:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T17:59:05.000Z (7 months ago)
- Last Synced: 2024-07-22T20:49:37.071Z (7 months ago)
- Topics: authentication, stytch, vue, vue3
- Language: Vue
- Homepage:
- Size: 551 KB
- Stars: 17
- Watchers: 3
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Stytch Vue example application
## Overview
This example application demonstrates how one may use Stytch within a Vue application. This project was bootstrapped with [create-vue](https://github.com/vuejs/create-vue).
This project uses Stytch's [JavaScript SDK](https://stytch.com/docs/sdks/javascript-sdk) which provides pre-built UI components and headless methods to securely interact with Stytch.
This application features Email Magic Links for authentication, as well as our Sessions Management product to manage user sessions. You can use this application's source code as a learning resource, or use it as a jumping off point for your own project. We are excited to see what you build with Stytch!
## Set up
Follow the steps below to get this application fully functional and running using your own Stytch credentials.
### In the Stytch Dashboard
1. Create a [Stytch](https://stytch.com/) account. Once your account is set up a Project called "My first project" will be automatically created for you.
2. Within your new Project, navigate to [SDK configuration](https://stytch.com/dashboard/sdk-configuration), and make the following changes:
- Click **Enable SDK**.
- Under **Authorized environments** add the domain `http://localhost:3000`.
- Within the **Email Magic Links** drawer, toggle on **Enable the LoginOrCreate Flow**.
3. Navigate to [Redirect URLs](https://stytch.com/dashboard/redirect-urls), and add `http://localhost:3000` as the types **Login** and **Sign-up**.
4. Finally, navigate to [API Keys](https://stytch.com/dashboard/api-keys), and copy your `public_token`. You will need this value later on.
### On your machine
In your terminal clone the project and install dependencies:
```bash
git clone https://github.com/stytchauth/stytch-vue-example.git
cd stytch-vue-example
npm i
```
Next, create `.env.local` file by running the command below and your `public_token`. Learn more about Vue's support for [custom environment variables here](https://cli.vuejs.org/guide/mode-and-env.html#environment-variables).
```bash
echo "VITE_STYTCH_PUBLIC_TOKEN=YOUR_TOKEN_HERE" > .env.local
# For example, echo "VITE_STYTCH_PUBLIC_TOKEN=public-token-test-123abcd-1234-1234-abcd-123123abcabc" > .env.local
```
## Running locally
After completing all the set up steps above the application can be run with the command:
```bash
npm run dev
```
The application will be available at [`http://localhost:3000`](http://localhost:3000).
You'll be able to login with Email Magic Links and see your Stytch User object, Stytch Session, and see how logging out works.
## Next steps
This example app showcases a small portion of what you can accomplish with Stytch. Here are a few ideas to explore:
1. Add additional login methods like [Passwords](https://stytch.com/docs/passwords#guides_getting-started-sdk).
2. Replace the prebuilt UI with your own using by using the SDK's [headless methods](https://stytch.com/docs/sdks/javascript-sdk).
3. Add a Google OAuth button with the high converting [Google One Tap UI](https://stytch.com/docs/oauth#guides_google-sdk).
4. Secure your app further by building MFA authentication using methods like [WebAuthn](https://stytch.com/docs/sdks/javascript-sdk#webauthn).
5. Use [Stytch Sessions](https://stytch.com/docs/sessions) to secure your backend.
## Get help and join the community
#### :speech_balloon: Stytch community Slack
Join the discussion, ask questions, and suggest new features in our [Slack community](https://stytch.com/docs/resources/support/overview)!
#### :question: Need support?
Check out the [Stytch Forum](https://forum.stytch.com/) or email us at [[email protected]](mailto:[email protected]).