Skip to content

Latest commit

 

History

History
100 lines (64 loc) · 5.3 KB

README.md

File metadata and controls

100 lines (64 loc) · 5.3 KB
Raw

Authgear banner

Authgear SDK for Single Page Applications (SPA)

@authgear/web @authgear/web @authgear/react-native @authgear/react-native License

With Authgear SDK for Single Page Applications (SPA), you can easily integrate authentication features into your app (Angular, Vue, React, or any JavaScript websites). In most cases, it involves just a few lines of code to enable multiple authentication methods, such as social logins, passwordless, biometrics logins, one-time-password (OTP) with SMS/WhatsApp, and multi-factor authentication (MFA).

Quick links - 📚 Documentation 🏁 Getting Started 🛠️ Troubleshooting 👥 Contributing

What is Authgear?

Authgear is a highly adaptable identity-as-a-service (IDaaS) platform for web and mobile applications. Authgear makes user authentication easier and faster to implement by integrating it into various types of applications - from single-page web apps to mobile applications to API services.

Key Features

  • Zero trust authentication architecture with OpenID Connect (OIDC) standard.
  • Easy-to-use interfaces for user registration and login, including email, phone, username as login ID, and password, OTP, magic links, etc for authentication.
  • Support a wide range of identity providers, such as Google, Apple, and Azure Active Directory (AD).
  • Support biometric login on mobile, Passkeys, and Multi-Factor Authentication (MFA) such as SMS/email-based verification and authenticator apps with TOTP.

Documentation

View other Authgear Documentation at https://docs.authgear.com/

Getting Started

Follow the easy steps to start using it:

Troubleshooting

Please check out our Get help to get solutions for common installation problems and other issues.

Raise an issue

To provide feedback or report a bug, please raise an issue on our issue tracker.

Contributing

Anyone who wishes to contribute to this project, whether documentation, features, bug fixes, code cleanup, testing, or code reviews, is very much encouraged to do so.

To join, just raise your hand on the Authgear Discord server (#trouble) or the GitHub Authgear's discussion board.

If you are unfamiliar with how to contribute to GitHub projects, here is a Getting Started Guide. A full set of contribution guidelines, along with templates, are in progress.

Or here is a quick way.

$ git clone --branch master [email protected]:<myusername>/authgear-sdk-js.git
$ cd authgear-sdk-js
$ npm ci
$ (cd website && yarn install --frozen-lockfile)

Releasing

First, ensure these tools are installed:

Also, Git should be configured to be able to sign using GPG keys, and npm should be logged in as appropriate user.

# VERSION should be in format like "0.1.0"
$ GIT_USER=<github-username> GITHUB_TOKEN=<github-token> GIT_BRANCH=master VERSION=<new-version> ./scripts/release.sh

Known issues

Apple silicon

See facebook/react-native#29605 (comment)

Supported and maintained by

Auhgear is a highly adaptable identity-as-a-service (IDaaS) platform for web and mobile applications. To learn more checkout website