ente/auth/README.md

# Ente Auth

Ente's 2FA app. An end-to-end encrypted, cross platform and free app for
storing your 2FA codes with cloud backups. Works offline. You can even use it
without signing up for an account if you don't want the cloud backups or
multi-device sync.

![App Screenshots](./screenshots/screenshots.png)

## 📲 Download

### Android

This repository's [GitHub
releases](https://github.com/ente-io/ente/releases/latest/download/ente-auth.apk)
contains APKs, built straight from source. These builds keep themselves updated,
without relying on third party stores.

You can alternatively install the build from PlayStore or F-Droid.

<a href="https://play.google.com/store/apps/details?id=io.ente.auth">
  <img height="59" src="../.github/assets/play-store-badge.png">
</a>
<a href="https://f-droid.org/packages/io.ente.auth/">
  <img height="59" src="../.github/assets/f-droid-badge.png">
</a>

### iOS / Apple Silicon macOS

<a href="https://apps.apple.com/us/app/ente-authenticator/id6444121398">
  <img height="59" src="../.github/assets/app-store-badge.svg">
</a>

### Web

You can view your 2FA codes at [auth.ente.io](https://auth.ente.io). For adding
or managing your secrets, please use our mobile app.

### Desktop

A native desktop app is coming soon!

## 🧑‍💻 Build from source

1. [Install Flutter](https://flutter.dev/docs/get-started/install)

2. Pull in all submodules with `git submodule update --init --recursive`

3. For Android, [setup your
   keystore](https://docs.flutter.dev/deployment/android#create-an-upload-keystore)
   and run `flutter build apk --release --flavor independent`

4. For iOS, run `flutter build ios`

## ⚙️ Develop

For Android, use

```sh
flutter run -t lib/main.dart --flavor independent
```

For iOS, use `flutter run`

VSCode users might find it useful to copy [docs/vscode](docs/vscode) into a top
level `.vscode`.

If the code you're working needs to modify user facing strings, see
[docs/localization](docs/localization.md).

## 🔩 Architecture

The architecture that powers end-to-end encrypted storage and sync of your
tokens has been documented [here](../architecture/README.md).

## 🌍 Translate

[![Crowdin](https://badges.crowdin.net/ente-authenticator-app/localized.svg)](https://crowdin.com/project/ente-authenticator-app)

If you're interested in helping out with translation, please visit our [Crowdin
project](https://crowdin.com/project/ente-photos-app) to get started. Thank you
for your support.

If your language is not listed for translation, please [create a GitHub
issue](https://github.com/ente-io/ente/issues/new?title=Request+for+New+Language+Translation&body=Language+name%3A)
to have it added.

## 🧑‍🎨 Icons

Ente Auth supports the icon pack provided by
[simple-icons](https://github.com/simple-icons/simple-icons). If you wish to add
more, see [docs/adding-icons](docs/adding-icons.md).

## 💚 Contribute

For more ways to contribute, see [../CONTRIBUTING.md](../CONTRIBUTING.md).

You can also support us by giving this project a ⭐ star on GitHub or by leaving
a review on
[PlayStore](https://play.google.com/store/apps/details?id=io.ente.auth),
[AppStore](https://apps.apple.com/us/app/ente-authenticator/id6444121398) or
[AlternativeTo](https://alternativeto.net/software/ente-authenticator/).

## ⭐️ About

To know more about Ente and the ways to get in touch or seek help, see [our main
README](../README.md) or visit [ente.io](https://ente.io).