README

Doorman 🚪🔥

Compatibility

v2 requires Firebase 8.

v3 (alpha) comes with headless mode, to allow users to customize usage for Firebase Web v9, and react-native-firebase.

Firebase v9 example usage with Doorman v2:

// App.js
import { makeHeadless } from 'react-doorman'
import { withPhoneAuth } from 'react-native-doorman'
import { getAuth, onIdTokenChanged, initializeApp } from 'firebase/auth'

const firebaseConfig = {
  //...
}
const firebaseApp = initializeApp(firebaseConfig)

// Call this at the root of your app before using doorman
makeHeadless({
  signOut: () => {
    return getAuth(firebaseApp).signOut()
  },
  onIdTokenChanged: callback => {
    return getAuth(firebaseApp).onIdTokenChanged(callback)
  },
  signInWithCustomToken: token => {
    return getAuth(firebaseApp).signInWithCustomToken(token)
  },
})

export default withPhoneAuth(App)

🧐 What is Doorman?

Doorman lets React Native developers add phone authentication to their apps with ease. It works perfectly with Firebase Auth and Expo.

We handle the backend and provide UI components 😇 for Firebase phone auth. That means you can spend less time worrying about the auth flow, and more time building your actual features.

Our mission is to help you create incredible apps that your users will love. And that all starts with the first impression they make with your app – your auth flow.

😎 With Doorman, you can...

👟Build a phone authentication flow in a few lines of code.
💅Fully customize the design to fit your app.

👩‍💻Avoid maintaining a complex server.
🔥Keep using Firebase Auth with Expo.
🕺Create a native auth experience, without web views or popups.

👾 Docs

We have great documentation. Check out our setup guide.

🤖 Examples

See our examples repo

👩‍💻 Website

Check out doorman.cool.

🚨 For issues

Please use this repository to notify us of any issues and track ones we're working on.

You can also live chat us on our website with any tight concerns. That said, we prefer that you make an issue here so that everyone else can fix problems you might have.

Usage no npm install needed!