ente/desktop/README.md

45 lines
960 B
Markdown
Raw Permalink Normal View History

## Desktop app for Ente Photos
2021-03-27 12:35:04 +00:00
The sweetness of Ente Photos, right on your computer. Linux, Windows and macOS.
2024-03-13 07:57:43 +00:00
You can
[**download** a pre-built binary from releases](https://github.com/ente-io/photos-desktop/releases/latest).
To know more about Ente, see [our main README](../README.md) or visit
[ente.io](https://ente.io).
## Building from source
2021-03-27 12:35:04 +00:00
2024-03-21 06:43:39 +00:00
> [!CAUTION]
>
> We're improving the security of the desktop app further by migrating to
> Electron's sandboxing and contextIsolation. These updates are still WIP and
> meanwhile the instructions below might not fully work on the main branch.
Fetch submodules
```sh
git submodule update --init --recursive
```
Install dependencies
2022-09-08 05:23:12 +00:00
```sh
yarn install
```
2022-09-08 05:23:12 +00:00
Run in development mode (supports hot reload for the renderer process)
2024-03-12 11:01:16 +00:00
```sh
yarn dev
2021-03-27 12:35:04 +00:00
```
2024-03-11 12:07:10 +00:00
2024-03-12 12:14:15 +00:00
Or create a binary for your platform
2024-03-11 12:07:10 +00:00
```sh
2024-03-12 12:14:15 +00:00
yarn build
2024-03-11 12:07:10 +00:00
```
2024-03-12 12:14:15 +00:00
That's the gist of it. For more development related documentation, see
[docs](docs/README.md).