Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teamhanko/passkeys-react-express
A React + Express example app with passkey authentication, using Hanko Passkey API
https://github.com/teamhanko/passkeys-react-express
nodejs passkey reactjs type typescript webauthn
Last synced: about 2 months ago
JSON representation
A React + Express example app with passkey authentication, using Hanko Passkey API
- Host: GitHub
- URL: https://github.com/teamhanko/passkeys-react-express
- Owner: teamhanko
- License: mit
- Created: 2024-03-06T09:00:05.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-06-06T05:55:54.000Z (7 months ago)
- Last Synced: 2024-06-06T07:12:26.363Z (7 months ago)
- Topics: nodejs, passkey, reactjs, type, typescript, webauthn
- Language: TypeScript
- Homepage:
- Size: 2.25 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Integrating Passkey Authentication in a React and Express App
This repository demonstrates how to add passkey login functionality to your React and Express app using the Hanko Passkey API. Passkey authentication is a secure and user-friendly alternative to traditional password-based authentication, providing a seamless login experience for users.
For a detailed tutorial on implementing passkey login in your React and Express app, refer to our blog post: [How to add a passkey login to your React app](https://www.hanko.io/blog/passkeys-react)
## Prerequisites
Before you begin, ensure you have the following:
- Node.js installed (version 20.0.0 or later)
- Hanko Passkey API key and tenant ID from [Hanko Cloud](https://cloud.hanko.io/)
> **Note:**
> You'll need to create a Passkey Project on Hanko Cloud with the App URL `http://localhost:5173`. See our docs to learn how to setup a [passkey project](https://docs.hanko.io/passkey-api/setup-passkey-project).
## Getting started
1. Clone the repository
```bash
git clone https://github.com/teamhanko/passkeys-react-express
```
2. Set up environment variables
Create a `.env` file in the `express-backend` directory and add the following environment variables:
```sh
PASSKEYS_API_KEY=your-hanko-passkey-api-key
PASSKEYS_TENANT_ID=your-hanko-passkey-tenant-id
```
Replace `your-hanko-passkey-api-key` and `your-hanko-passkey-tenant-id` with your actual Hanko Passkey API key and tenant ID.
#### Frontend
1. Navigate to the frontend directory:
```bash
cd react-frontend
```
2. Install the frontend dependencies using your preferred package manager (e.g., `npm`, `pnpm`, `yarn`, or `bun`). For this project, we've used `pnpm`:
```bash
pnpm install
```
3. Start the frontend development server:
```bash
pnpm dev
```
#### Backend
1. Navigate to the backend directory:
```bash
cd express-backend
```
2. Install the backend dependencies:
```bash
pnpm install
```
3. Start the backend server:
```bash
pnpm dev
```
## Usage
1. Start the application:
* Ensure that both the frontend and backend servers are running.
* Access the application by navigating to `http://localhost:5173` in your web browser.
2. Log in with a pre-configured user: Navigate to login page, login with one of the pre-configured users.
```json
{
"id": "b3fbbdbd-6bb5-4558-9055-3b54a9469629",
"email": "[email protected]",
"password": "password123",
},
{
"id": "22c81b3d-1e7d-4a72-a6b0-ad946e0c0965",
"email": "[email protected]",
"password": "very_secure_password",
},
{
"id": "55c81b3d-1e7d-4a72-a6b0-ad946e0c0965",
"email": "[email protected]",
"password": "123",
}
```
3. Register a passkey:
* After logging in, register a passkey for the logged-in user.
4. Log out:
* After the passkey registration is successful, log out of the application.
5. Login with with a passkey
* On the login page, choose sign in with a passkey option to authenticate using a passkey.
## Support
Feel free to reach out to us on [Discord](https://hanko.io/community) if you get into any issues.
## License
This project is licensed under the MIT License.