Quickstart
This quickstart will get you up and running with auth in about 10 minutes.
1. Add your signup form
Paste your code snippet
- Paste the
<script>
inside the<head>
of your HTML - Use the
<signup-form>
element inside the<body>
of your HTML View
2. Use your signup form
Give it a try: fill out your signup form and submit it.
Upon successful signup, the form does 2 things:
Redirects the browser to
/dashboard
.We'll edit this next.
Adds a secure access token named
access.<YOUR WORKSPACE_ID>
to your browser's cookies.This token is a JWT with the user's information, which you can send to your own backend.
Your form is in test mode, which means it creates a user record in your test environment when the form is submitted.
3. Set your redirect & domain
In your Redirect paths page, update the After-signup path to /home
.
Now when you re-submit your signup form, you should be redirected to /home
.
4. Add login and others
Follow the same process for your other tools:
/login
page./reset
page.For logout most of our users typically choose to call Userfront.logout()
from Userefront's core.js library directly.
Read more about Corejs#logout here.
Test mode vs live mode
Userfront forms and API calls operate in the context of a "mode", either live
or test
mode. When you deploy your forms to any of your live domains and the browser is using HTTPS, the forms will operate in live
mode automatically, otherwise they will operate in test
mode.
Read more about the differences between live & test mode here.
Finished
Congratulations, you've added auth to your site.
To enable live
mode, add your website to the list of live domains on the Live domains page.