ente/mobile/README.md
2024-05-23 14:17:47 +05:30

3.2 KiB

Mobile app for Ente Photos

Source code for our flagship mobile app. For us, this is our most important client app. This is where Ente started. This is what had the first commit.

commit a8cdc811fd20ca4289d8e779c97f08ef5d276e37
Author: Vishnu Mohandas <vishnumohandas@gmail.com>
Date:   Wed Mar 25 01:29:36 2020 +0530

    Hello world

To know more about Ente, see our main README or visit ente.io.

To use Ente Photos on the web, see ../web. To use Ente Photos on the desktop, see ../desktop. There is a also a CLI tool for easy / automated exports.

If you're looking for Ente Auth instead, see ../auth.

📲 Installation

Android

The GitHub releases contain APKs, built straight from source. The latest build is available at ente.io/apk. These builds keep themselves updated, without relying on third party stores.

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

iOS

🧑‍💻 Building from source

  1. Install Flutter v3.22.0.

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

  3. Enable repo git hooks git config core.hooksPath hooks

  4. If using Visual Studio Code, add the Flutter Intl extension

  5. On Android:

    • For development, run flutter run -t lib/main.dart --flavor independent

    • For building APK, setup your keystore and run flutter build apk --release --flavor independent

  6. For iOS, run flutter build ios

Some common issues and troubleshooting tips are in docs/dev.

VSCode users might find it useful to copy docs/vscode into a top level .vscode.

🏙️ Attributions

City coordinates from Simple Maps

🌍 Translate

Crowdin

If you're interested in helping out with translation, please visit our Crowdin project to get started. Thank you for your support.

If your language is not listed for translation, please create a GitHub issue to have it added.

💚 Contribute

For more ways to contribute, see ../CONTRIBUTING.md.