remix-auth-totp/README.md

A Time-Based One-Time Password (TOTP) Authentication Strategy for Remix-Auth.

<h1 align="center">
  📧 Remix Auth TOTP
</h1>

<div align="center">
  <p>
    A <strong>Time-Based One-Time Password (TOTP) Authentication Strategy</strong> for <a href="https://github.com/sergiodxa/remix-auth">Remix Auth</a> that implements <strong>Email-Code & Magic-Link Authentication</strong> in your application.
  </p>
</div>

<div align="center">
  <p>
    <a href="https://github.com/dev-xo/remix-auth-totp/tree/main/docs#getting-started"><strong>Get Started »</strong></a>
    <br/><br/>
    <a href="https://totp.fly.dev">Live Demo</a>
    ·
    <a href="https://github.com/dev-xo/remix-auth-totp/tree/main/docs">Documentation</a>
    ·
    <a href="https://github.com/dev-xo/remix-auth-totp/blob/main/docs/examples.md">Examples</a>
  </p>
</div>

```
npm install remix-auth-totp
```

[![CI](https://img.shields.io/github/actions/workflow/status/dev-xo/remix-auth-totp/main.yml?label=Build)](https://github.com/dev-xo/remix-auth-totp/actions/workflows/main.yml)
[![Release](https://img.shields.io/npm/v/remix-auth-totp.svg?&label=Release)](https://www.npmjs.com/package/remix-auth-totp)
[![License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://github.com/dev-xo/remix-auth-totp/blob/main/LICENSE)

## Features

- **⭐ Remix & React Router v7** - Out of the box support.
- **📧 Built-In Magic Link** - Authenticate users with a Click.
- **⛅ Cloudflare Support** - Works with Cloudflare Pages.
- **🔐 Secure** - Encrypted Time-Based Codes.
- **🛡 Bulletproof** - Crafted in strict TypeScript with high test coverage.
- **😌 Easy to Set Up** - Start with one of the Official Starters.
- **🚀 Remix Auth Foundation** - An amazing authentication library for Remix.

## [Live Demo](https://totp.fly.dev)

[![Remix Auth TOTP](https://raw.githubusercontent.com/dev-xo/dev-xo/main/remix-auth-totp/demo-thumbnail.png)](https://totp.fly.dev)

## Getting Started

Please, read the [Getting Started Documentation](https://github.com/dev-xo/remix-auth-totp/tree/main/docs#remix-auth-totp-documentation) in order to set up **Remix Auth TOTP** in your application.

> [!TIP]
> As a faster alternative, you can start with one of the [Example Templates](https://github.com/dev-xo/remix-auth-totp/blob/main/docs/examples.md).

## Support

If you found **Remix Auth TOTP** helpful, please consider supporting it with a ⭐ [Star](https://github.com/dev-xo/remix-auth-totp).

### Acknowledgments

Big thanks to [@w00fz](https://github.com/w00fz) for its amazing implementation of the **Magic Link feature**.

Special thanks to [@mw10013](https://github.com/mw10013) for the **Cloudflare Support** implementation, the `v2` and `v3` **Releases**, and all the dedication and effort set into the project.

Huge thanks to [@CyrusVorwald](https://github.com/CyrusVorwald) for the **v4** release, and the effort to make it React Router v7 compatible.

## License

Licensed under the [MIT license](https://github.com/dev-xo/remix-auth-totp/blob/main/LICENSE).