ente/README.md

102 lines
3.9 KiB
Markdown
Raw Normal View History

2022-02-20 10:12:20 +00:00
# ente - simple, safe photo storage
2021-05-18 20:39:02 +00:00
2022-02-20 10:12:20 +00:00
**ente** is a cloud storage provider that provides end-to-end encryption for your data.
2021-07-26 04:19:36 +00:00
2022-02-20 10:12:20 +00:00
We have open-source apps across Android, iOS, web and desktop that automatically backup your photos and videos.
2021-08-13 02:30:44 +00:00
This repository contains the code for our mobile apps, built with a lot of ❤️, and a little bit of [Flutter](https://flutter.dev).
![App Screenshots](https://user-images.githubusercontent.com/24503581/175218240-fe5a0703-82c1-4750-bfea-abfd9f409a97.png)
<br/>
2021-08-22 19:13:36 +00:00
2022-02-20 10:12:20 +00:00
## ✨ Features
- Client side encryption (only you can view your photos and videos)
- Background sync
- Family plans
2022-02-20 10:12:20 +00:00
- Shareable links for albums
- Highlights of memories from previous years
- Search by album, day, month, year, and file types (more in the works...)
2022-02-20 10:12:20 +00:00
- Ability to detect and delete duplicate files
- Light and dark mode
2022-02-20 10:12:20 +00:00
- Image editor
- EXIF viewer
- Ability to free up disk space by deleting backed up photos
- Support for Live Photos
2022-02-20 10:12:20 +00:00
- Recycle bin
- 2FA
- Lockscreen
- Zero third-party tracking / analytics
2022-06-23 05:32:04 +00:00
<br/>
2022-02-20 10:12:20 +00:00
## 📲 Installation
### Android
This [repository's GitHub
releases](https://github.com/ente-io/photos-app/releases) contains APKs, built
straight from source. The latest build is available @
[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">
2022-05-21 10:35:24 +00:00
<img width="197" alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png">
</a>
<a href="https://f-droid.org/packages/io.ente.photos.fdroid/">
<img width="197" alt="Get it on F-Droid" src="https://fdroid.gitlab.io/artwork/badge/get-it-on.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 width="197" alt="Download on AppStore" src="https://user-images.githubusercontent.com/1161789/154795157-c4468ff9-97fd-46f3-87fe-dca789d8733a.png">
</a>
2022-06-23 05:32:04 +00:00
<br/>
<br/>
2022-02-20 10:12:20 +00:00
## 🧑‍💻 Building from source
2021-08-22 19:13:36 +00:00
2021-08-22 19:18:30 +00:00
1. [Install Flutter](https://flutter.dev/docs/get-started/install)
2. Clone this repository with `git clone git@github.com:ente-io/photos-app.git`
2022-02-21 05:00:05 +00:00
3. Pull in all submodules with `git submodule update --init --recursive`
4. Enable repo git hooks `git config core.hooksPath hooks`
2023-02-08 14:09:18 +00:00
5. Setup TensorFlowLite by executing `setup.sh`
6. For Android, [setup your keystore](https://docs.flutter.dev/deployment/android#create-an-upload-keystore) and run `flutter build apk --release --flavor independent`
2023-02-08 14:09:18 +00:00
7. For iOS, run `flutter build ios`
2022-06-23 05:32:04 +00:00
<br/>
2022-02-20 10:12:20 +00:00
## 🙋 Help
2022-02-20 10:27:57 +00:00
We provide human support to our customers. Please write to [support@ente.io](mailto:support@ente.io) sharing as many details as possible about whatever it is that you need help with, and we will get back to you as soon as possible.
2022-06-23 05:32:04 +00:00
<br/>
2022-02-20 10:18:10 +00:00
## 🧭 Roadmap
We maintain a public roadmap, that's driven by our community @ [roadmap.ente.io](https://roadmap.ente.io).
2022-06-23 05:32:04 +00:00
<br/>
2022-02-20 10:12:20 +00:00
## 🤗 Support
If you like this project, please consider upgrading to a paid subscription.
If you would like to motivate us to keep building, you can do so by
[starring](https://github.com/ente-io/photos-app/stargazers) this project.
2023-04-05 05:28:32 +00:00
<br/>
2023-04-05 05:30:50 +00:00
## 🌍 Translations
2023-04-05 05:30:14 +00:00
[![Crowdin](https://badges.crowdin.net/ente-photos-app/localized.svg)](https://crowdin.com/project/ente-photos-app)
2022-02-20 10:12:20 +00:00
2023-04-05 05:30:14 +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.
2022-06-23 05:32:04 +00:00
<br/>
2022-02-20 10:12:20 +00:00
## ❤️ Join the Community
2021-08-22 19:18:30 +00:00
Follow us on [Twitter](https://twitter.com/enteio), join [r/enteio](https://reddit.com/r/enteio) or hang out on our [Discord](https://ente.io/discord) to get regular updates, connect with other customers, and discuss your ideas.
2021-08-22 19:18:30 +00:00
2022-02-20 10:12:20 +00:00
An important part of our journey is to build better software by consistently listening to community feedback. Please feel free to [share your thoughts](mailto:feedback@ente.io) with us at any time.