Giter VIP home page Giter VIP logo

supauth's Introduction

supauth

Supauth for Nuxt

Nuxt Layer with all you need to start your next Nuxt + Supabase project without having to worry about the auth system.

👉 Check the docs here!

🚧 This layer is still an experiment that will have many changes in the future, but feel free to try it and suggest changes or report problems.

Features

  • Sign up with email and password
  • Sign in with providers
  • Auth middlewares

This layer is based on the oxecore layer which includes the UnoCSS, Nuxt-Icon and VueUse modules by default, although you can expect that in the future it will not have dependencies that alter your project outside of the login screens.

To do

  • Add magic-link login
  • Internationalization
  • Reset password page

Setup

npm i -D supauth # yarn add -D supauth
// ~~/nuxt.config.ts
export default defineNuxtConfig({
	extends: ['supauth'],
})

Modules Preset

  • Supabase
  • UnoCSS*
  • Nuxt Icon*
  • VueUse*

*coming from oxecore layer

Usage

To start using this layer, just follow the setup instructions and create a .env file with your Supabase credentials:

// .env
SUPABASE_KEY=
SUPABASE_URL=

Then, you can run your project and go to /login to sign in or /register to create a new user.

Since this layer is using the @nuxtjs/supabase module, you can of course use all the functions and utilities coming from that module (useSupabaseClient, useSupabaseUser, etc).

Options

export default defineAppConfig({
	supauth: {
		confirm: true, // enable if you have email confirmation on
		redirect: '/', // the path you want to redirect your users after login
		providers: ['google', 'github'], // the oauth providers you want to enable
		legalAdvice: {
			privacy: '/privacy-policy',
			terms: '/terms-and-conditions',
		}, // legal links to show below the auth forms. you can set it to false to don't show any legal advice
	},
})

Middlewares

  • authenticated (if there isn’t a user logged-in, you’re gonna be redirected to /login)
  • unauthenticated (if there is a user logged-in, you’re gonna be redirected to /, or the redirect path in the options of the layer.

Any comment, suggestion, report or pull request is absolutely welcome!

supauth's People

Contributors

imlautaro avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

a7medsamirf

supauth's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.