Skip to content

Commit

Permalink
add readme and electron start script
Browse files Browse the repository at this point in the history
  • Loading branch information
cloverich committed Aug 13, 2020
1 parent 12e8989 commit 43ded57
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Chronicles

**Status**: In development. Bugs abound. See releases to download the application.



## Development

All of the application code lives in the `/ui` directory. Ignore the others :)



The app is a typical Electron dev setup, but serves the UI from webpack dev server while in development. To start the app you'll need to start both the webpack dev server and electron.

```bash
cd ui

# install dependencies
yarn

# start webpack
yarn dev

# start electron
# yarn dev:electron
```





## Build and release

- Use the `ui/build.sh` script
- Make a Github release

1 change: 1 addition & 0 deletions ui/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"license": "UNLICENSED",
"scripts": {
"dev": "webpack-dev-server --config webpack.js --hot --inline --colors",
"dev:electron": "electron src/electron/index.js",
"test": "mocha -r ts-node/register -r esm src/**/*.spec.ts"
},
"dependencies": {
Expand Down

0 comments on commit 43ded57

Please sign in to comment.