ente/README.md

38 lines
1.7 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-04-02 09:15:11 +00:00
Electron 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-04-02 09:15:11 +00:00
## To Use
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.
## Re-compile automatically
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
```
2021-04-02 09:15:11 +00:00
## Resources for Learning Electron
- [electron.atom.io/docs](http://electron.atom.io/docs) - all of Electron's documentation
- [electron.atom.io/community/#boilerplates](http://electron.atom.io/community/#boilerplates) - sample starter apps created by the community
- [electron/electron-quick-start](https://github.com/electron/electron-quick-start) - a very basic starter Electron app
- [electron/simple-samples](https://github.com/electron/simple-samples) - small applications with ideas for taking them further
- [electron/electron-api-demos](https://github.com/electron/electron-api-demos) - an Electron app that teaches you how to use Electron
- [hokein/electron-sample-apps](https://github.com/hokein/electron-sample-apps) - small demo apps for the various Electron APIs