|
6 | 6 |
|
7 | 7 | # electron-starter |
8 | 8 |
|
9 | | -This is a electron starter kit from some random guy on the Internet. |
| 9 | +This is a `TypeScript` and `React` starter kit for building Electron apps. |
10 | 10 |
|
11 | | -[Check out the docs](https://skellock.github.io/electron-starter) for all the gory details. |
| 11 | +[Check out the docs](https://skellock.github.io/electron-starter) for some of the choices and motivations. |
12 | 12 |
|
13 | | -# example |
| 13 | + |
| 14 | +### Example |
| 15 | + |
| 16 | +You have to bring your own awesome. But here's a picture* after `npm i` and `npm start` and `npm storybook`... |
14 | 17 |
|
15 | 18 | <img src='./docs/demo.gif' width='450' /> |
16 | 19 |
|
17 | | -It's not much to look at really. Just a barebones boilerplate. You need to bring your own awesome. |
| 20 | +><small>* What it looks like moments before you hit the delete button to nuke all the staged features..</small> |
| 21 | +
|
| 22 | + |
| 23 | +# Out of the Box |
| 24 | + |
| 25 | +### Electron Features 💫 |
| 26 | + |
| 27 | +* ability to build all 3 platforms on your mac |
| 28 | +* auto-update your apps! |
| 29 | +* a simple library for css styling |
| 30 | +* fast & fluid animation engine |
| 31 | +* fantastic keyboard support |
| 32 | +* save window position between launches |
| 33 | +* persist application data as JSON |
| 34 | +* sane styling defaults on windows, mac, and linux |
| 35 | + |
| 36 | +### Devs Like Nice Things Too 🔨 |
| 37 | + |
| 38 | +* super-fast hot reloading 🔥 |
| 39 | +* lean production bundles |
| 40 | +* integrated storybook support |
| 41 | +* unit tests with mocking |
| 42 | +* 100% code coverage with examples on how to keep it there |
| 43 | +* code linting & formatting |
| 44 | + |
| 45 | +### Documentation & Samples 🖨 |
| 46 | + |
| 47 | +* how to quickly jettison parts you don't want |
| 48 | +* why we chose the stack we did |
| 49 | +* how to structure your electron app |
| 50 | +* a simple & co-located approach to building your components |
| 51 | + |
| 52 | +### Not Included 💣 |
| 53 | + |
| 54 | +* lock in... keep what works for you, ditch the rest |
| 55 | +* state management... `mobx`? / `redux`? ... both awesome. both excluded. |
| 56 | +* a component toolkit |
| 57 | + |
| 58 | + |
| 59 | +# License 🎤 |
| 60 | + |
| 61 | +You down with MIT? |
| 62 | + |
18 | 63 |
|
0 commit comments