https://github.com/authgear/authgear-example-ionic
https://github.com/authgear/authgear-example-ionic
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/authgear/authgear-example-ionic
- Owner: authgear
- Created: 2025-02-10T12:03:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-04T04:23:17.000Z (about 1 year ago)
- Last Synced: 2025-04-04T05:24:14.960Z (about 1 year ago)
- Language: TypeScript
- Size: 434 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Authgear sample for Ionic
This repo demonstrates how to add authentication into an Ionic apps using Authgear.
## Project setup
1. Clone repo
2. Install dependencies command:
```
npm install
```
### Create Free Authgear Account
1. Goto [https://portal.authgear.com](https://portal.authgear.com) and create a free account (or login to your existing account).
2. Then navigate to Applications and create a new client application of type Native App.
### Configuration
The project needs to be configured with your Authgear app's Endpoint and client ID in order for the authentication flow to work.
To do this, rename `.env.example` in the root directory of the project to `.env`, then open the file and add your Authgear client application's Client ID and Endpoint as the value for `VITE_AUTHGEAR_CLIENT_ID` and `VITE_AUTHGEAR_ENDPOINT` respectively.
Add the following URIs to your Authgear client application's Authorized Redirect URI:
- `com.authgear.example.capacitor://host/path`
- `capacitor://localhost`
- `http://localhost:8100/oauth-redirect`
- `https://localhost`
To test the app on the web, run the following command:
```
ionic serve
```
To build and run your application on mobile, use the following commands:
Build your code:
```
npm run build
```
Sync changes to mobile platforms
```
npx cap sync
```
Open project on Android:
```
npx cap open android
```
Or open project on iOS:
```
npx cap open ios
```
Run your project from Android Studio or Xcode.
## What is Authgear?
[Authgear](https://www.authgear.com/) 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](https://openid.net/developers/how-connect-works/) (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](https://developers.google.com/identity), [Apple](https://support.apple.com/en-gb/guide/deployment/depa64848f3a/web), and [Azure Active Directory](https://azure.microsoft.com/en-gb/products/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/](https://docs.authgear.com/)