Skip to content

Latest commit

 

History

History
62 lines (50 loc) · 1.76 KB

README.md

File metadata and controls

62 lines (50 loc) · 1.76 KB

🔐 Fake Auth

A fake auth service for prototyping authentication flows and error states. It currently supports signin, signup, signinWithProvider (google, fb, etc), password resetting, updating email, updating profile data, and subscribing to auth state changes.

Everything is client-side, including the "database" which is stored in local storage. Perfect for quick prototyping or theme developers who'd like to have a demo site without needing to setup a backend.

Install

npm install fake-auth --save

Usage

A simple example with React

import React, { useState } from "react";
import fakeAuth from "fake-auth";

function SigninComponent(props) {
  const [error, setError] = useState();

  const handleSubmit = (email, pass) => {
    fakeAuth
      .signin(email, pass)
      .then((response) => {
        props.onSignin(response.user);
      })
      .catch((error) => {
        setError(error);
      });
  };

  return (
    <form
      onSubmit={(event) => {
        const [email, pass] = event.target.children;
        handleSubmit(email, pass);
      }}
    >
      {error && <p>{error.message}</p>}
      <input type="email" name="email" />
      <input type="password" name="pass" />
    </form>
  );
}

Methods

  • signup(email, pass).then((response) => ...)
  • signin(email, pass).then((response) => ...)
  • signinWithProvider(provider).then((response) => ...)
  • signout().then(() => ...)
  • onChange((response) => ...)
  • sendPasswordResetEmail(email).then(() => ...)
  • confirmPasswordReset(email, code).then(() => ...)
  • updateEmail(email).then(() => ...)
  • updatePassword(pass).then(() => ...)
  • updateProfile(data).then(() => ...)
  • getCurrentUser().then((user) => ...)