Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teamhanko/passkeys-remix
A Remix example app with passkey authentication, using Hanko Passkey API
https://github.com/teamhanko/passkeys-remix
passkeys remix remix-run typescript webauthn
Last synced: about 1 month ago
JSON representation
A Remix example app with passkey authentication, using Hanko Passkey API
- Host: GitHub
- URL: https://github.com/teamhanko/passkeys-remix
- Owner: teamhanko
- License: mit
- Created: 2024-02-28T11:19:31.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-05-02T11:56:57.000Z (8 months ago)
- Last Synced: 2024-07-30T19:49:12.915Z (5 months ago)
- Topics: passkeys, remix, remix-run, typescript, webauthn
- Language: TypeScript
- Homepage: https://passkeys-remix.vercel.app
- Size: 2.29 MB
- Stars: 0
- 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 Remix App
This repository demonstrates how to add passkey login functionality to your Remix 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 Solid.js app, refer to our blog post: [Adding passkeys to a Remix app](https://www.hanko.io/blog/passkeys-remix)
## 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:3000`. 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-remix
```
2. Set up environment variables
* Create a `.env` file in the root 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.
3. Install the dependencies using your preferred package manager (e.g., `npm`, `pnpm`, `yarn`, or `bun`). For this project, we've used `pnpm`:
```bash
pnpm install
```
4. Start the development server:
```bash
pnpm dev
```
## Usage
1. Start the application:
* Access the application by navigating to `http://localhost:3000` 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",
}
```
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.