https://github.com/lukejacksonn/hyperapp-electron

A minimal electron app starter with hyperapp, livereload and redux devtools
https://github.com/lukejacksonn/hyperapp-electron

Last synced: 3 months ago
JSON representation

A minimal electron app starter with hyperapp, livereload and redux devtools

• Host: GitHub
• URL: https://github.com/lukejacksonn/hyperapp-electron
• Owner: lukejacksonn
• Created: 2017-07-06T00:02:11.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-01-05T17:24:52.000Z (about 7 years ago)
• Last Synced: 2024-10-15T03:23:11.431Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 22.5 KB
• Stars: 51
• Watchers: 5
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• hyperawesome - lukejacksonn/hyperapp-electron - Minimal Electron app starter with Hyperapp, LiveReload and Redux DevTools. (Boilerplates V1)

README

        
# hyperapp-electron

![hyperapp-electron-app-screenshot](https://user-images.githubusercontent.com/1457604/27892734-4e7ef35a-61f9-11e7-8ecb-6b28a6c26515.png)

**Clone and run for a quick way to see Electron and HyperApp in action.**

This is a minimal Electron application based on the [Quick Start Guide](http://electron.atom.io/docs/tutorial/quick-start) within the Electron documentation. It also has [HyperApp](https://github.com/hyperapp/hyperapp), [LiveReload](https://github.com/napcs/node-livereload) and [Redux Devtools](https://github.com/gaearon/redux-devtools).

A basic Electron application needs just these files:

- `package.json` - Points to the app's main file and lists its details and dependencies.

- `main.js` - Starts the app and creates a browser window to render HTML. This is the app's **main process**.

- `index.html` - A web page to render. This is the app's **renderer process**.

You can learn more about each of these components within the [Quick Start Guide](http://electron.atom.io/docs/tutorial/quick-start).

## 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/lukejacksonn/hyperapp-electron

# Go into the repository

cd hyperapp-electron

# 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.

## 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

## License

[CC0 1.0 (Public Domain)](LICENSE.md)