ente/README.md

47 lines
1.9 KiB
Markdown
Raw Normal View History

2021-04-02 09:15:11 +00:00
# bhari-frame (heavy-frame)
2021-03-27 12:35:04 +00:00
2021-08-22 19:06:02 +00:00
Desktop app for [ente.io](https://ente.io) build with [electron](https://electronjs.org) and loads of ❤️.
2021-03-27 12:35:04 +00:00
2021-08-22 19:06:02 +00:00
## Disclaimer
We are aware that electron is a sub-optimal choice for building desktop applications.
The goal of this app was to
1. provide a stable environment for customers to back up large amounts of data reliably
2. export uploaded data from our servers to their local hard drives.
Electron was the best way to reuse our battle tested code from [bada-frame](https://github.com/ente-io/bada-frame) that powers [web.ente.io](https://web.ente.io).
As an archival solution built by a small team, we are hopeful that this project will help us keep our stack lean, while ensuring a painfree life for our customers.
If you are running into issues with this app, please drop a mail to [support@ente.io](mailto:support@ente.io) and we'll be very happy to help.
## Download
- [Latest Release](https://github.com/ente-io/bhari-frame/releases/latest)
2022-07-07 18:35:55 +00:00
- On the [AUR](https://aur.archlinux.org/packages/ente-desktop-appimage): `yay -S ente-desktop-appimage`
2021-08-22 19:06:02 +00:00
## Develop
2021-04-02 09:15:11 +00:00
To clone and run this repository you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:
```bash
# Clone this repository
git clone https://github.com/ente-io/bhari-frame
# Go into the repository
cd bhari-frame
# Install dependencies
npm install
# Run the app
npm start
```
Note: If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt.
2021-08-22 19:06:02 +00:00
### Re-compile automatically
2021-04-02 09:15:11 +00:00
To recompile automatically and to allow using [electron-reload](https://github.com/yan-foto/electron-reload), run this in a separate terminal:
2021-03-27 12:35:04 +00:00
```bash
2021-04-02 09:15:11 +00:00
npm run watch
2021-03-27 12:35:04 +00:00
```