https://github.com/worldbrain/storex-hub-gui-electron
Electron-based GUI for Storex Hub
https://github.com/worldbrain/storex-hub-gui-electron
Last synced: 8 months ago
JSON representation
Electron-based GUI for Storex Hub
- Host: GitHub
- URL: https://github.com/worldbrain/storex-hub-gui-electron
- Owner: WorldBrain
- Created: 2020-06-03T08:54:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T02:47:51.000Z (over 3 years ago)
- Last Synced: 2024-10-30T04:29:59.386Z (over 1 year ago)
- Language: TypeScript
- Size: 1.76 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# electron-webpack-quick-start
> A bare minimum project structure to get started developing with [`electron-webpack`](https://github.com/electron-userland/electron-webpack).
Thanks to the power of `electron-webpack` this template comes packed with...
* Use of [`webpack-dev-server`](https://github.com/webpack/webpack-dev-server) for development
* HMR for both `renderer` and `main` processes
* Use of [`babel-preset-env`](https://github.com/babel/babel-preset-env) that is automatically configured based on your `electron` version
* Use of [`electron-builder`](https://github.com/electron-userland/electron-builder) to package and build a distributable electron application
Make sure to check out [`electron-webpack`'s documentation](https://webpack.electron.build/) for more details.
## Getting Started
Simply clone down this repository, install dependencies, and get started on your application.
The use of the [yarn](https://yarnpkg.com/) package manager is **strongly** recommended, as opposed to using `npm`.
```bash
# create a directory of your choice, and copy template using curl
mkdir new-electron-webpack-project && cd new-electron-webpack-project
curl -fsSL https://github.com/electron-userland/electron-webpack-quick-start/archive/master.tar.gz | tar -xz --strip-components 1
# or copy template using git clone
git clone https://github.com/electron-userland/electron-webpack-quick-start.git
cd electron-webpack-quick-start
rm -rf .git
# install dependencies
yarn
```
### Development Scripts
```bash
# run application in development mode
yarn dev
# compile source code and create webpack output
yarn compile
# `yarn compile` & create build with electron-builder
yarn dist
# `yarn compile` & create unpacked build with electron-builder
yarn dist:dir
```