ente/mobile/README.md

92 lines
3.1 KiB
Markdown
Raw Normal View History

# Mobile app for Ente Photos
2021-05-18 20:39:02 +00:00
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](https://github.com/ente-io/ente/commit/a8cdc811fd20ca4289d8e779c97f08ef5d276e37).
2021-07-26 04:19:36 +00:00
commit a8cdc811fd20ca4289d8e779c97f08ef5d276e37
Author: Vishnu Mohandas <vishnumohandas@gmail.com>
Date: Wed Mar 25 01:29:36 2020 +0530
2021-08-13 02:30:44 +00:00
Hello world
To know more about Ente, see [our main README](../README.md) or visit
[ente.io](https://ente.io).
To use Ente Photos on the web, see [../web](../web/README.md). To use Ente
Photos on the desktop, see [../desktop](../desktop/README.md). There is a also a
[CLI tool](../cli/README.md) for easy / automated exports.
2021-08-22 19:13:36 +00:00
If you're looking for Ente Auth instead, see [../auth](../auth/README.md).
2022-06-23 05:32:04 +00:00
2022-02-20 10:12:20 +00:00
## 📲 Installation
### Android
The [GitHub releases](https://github.com/ente-io/photos-app/releases) contain
APKs, built straight from source. The latest build is available at
[ente.io/apk](https://ente.io/apk). These builds keep themselves updated,
without relying on third party stores.
2022-02-20 10:12:20 +00:00
2022-05-21 10:35:24 +00:00
You can alternatively install the build from PlayStore or F-Droid.
2022-02-20 10:12:20 +00:00
<a href="https://play.google.com/store/apps/details?id=io.ente.photos">
<img height="59" src="../.github/assets/play-store-badge.png">
2022-05-21 10:35:24 +00:00
</a>
<a href="https://f-droid.org/packages/io.ente.photos.fdroid/">
<img height="59" src="../.github/assets/f-droid-badge.png">
2022-02-20 10:12:20 +00:00
</a>
### iOS
2022-02-20 10:12:20 +00:00
<a href="https://apps.apple.com/in/app/ente-photos/id1542026904">
<img height="59" src="../.github/assets/app-store-badge.svg">
2022-02-20 10:12:20 +00:00
</a>
## 🧑‍💻 Building from source
2021-08-22 19:13:36 +00:00
2024-03-13 08:21:20 +00:00
1. [Install Flutter v3.13.4](https://flutter.dev/docs/get-started/install).
2022-06-23 05:32:04 +00:00
2. Pull in all submodules with `git submodule update --init --recursive`
2022-02-20 10:12:20 +00:00
3. Enable repo git hooks `git config core.hooksPath hooks`
2022-06-23 05:32:04 +00:00
4. If using Visual Studio Code, add the [Flutter
Intl](https://marketplace.visualstudio.com/items?itemName=localizely.flutter-intl)
extension
2022-02-20 10:18:10 +00:00
5. On Android:
2022-06-23 05:32:04 +00:00
* For development, run `flutter run -t lib/main.dart --flavor independent`
2022-02-20 10:12:20 +00:00
* For building APK, [setup your
keystore](https://docs.flutter.dev/deployment/android#create-an-upload-keystore)
and run `flutter build apk --release --flavor independent`
2022-02-20 10:12:20 +00:00
6. For iOS, run `flutter build ios`
2023-04-05 05:28:32 +00:00
Some common issues and troubleshooting tips are in [docs/dev](docs/dev.md).
2022-02-20 10:12:20 +00:00
VSCode users might find it useful to copy [docs/vscode](docs/vscode) into a top
level `.vscode`.
## 🏙️ Attributions
2022-06-23 05:32:04 +00:00
City coordinates from [Simple Maps](https://simplemaps.com/data/world-cities)
2021-08-22 19:18:30 +00:00
## 🌍 Translate
[![Crowdin](https://badges.crowdin.net/ente-photos-app/localized.svg)](https://crowdin.com/project/ente-photos-app)
2021-08-22 19:18:30 +00:00
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.
2023-12-26 17:53:46 +00:00
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.
## 💚 Contribute
2023-12-26 17:53:46 +00:00
For more ways to contribute, see [../CONTRIBUTING.md](../CONTRIBUTING.md).