Skip to content
This repository was archived by the owner on Jun 5, 2019. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

Hey, so everyone has their favourites right? Here's a few of mine.


## Language

> **typescript**
Expand All @@ -26,11 +27,11 @@ Some automation so I stop checking in crap-looking code.

Can't imagine doing web differently to be honest. I'm sure we will soon, but for mid-2017, this is dominating.

> **rebass**
> **vanilla react**

I'm not sure if I'll keep this one, but it's looking good for now. It brings a great way to stitch together UIs.
There are lot of great libraries out there for UI. This intentionally uses none of them. Don't hestitate to bring one in and use it if that's how you roll.

It brings, however, a butt-tonne of dependencies (29) including, most notably, `styled-components` although that is behind the scenes.
I'm keep it straight-up react here because some types of apps I'd will be using webgl, pixi, or are pure svg interfaces.


## State Management
Expand All @@ -43,6 +44,7 @@ It brings the same things to the table as `redux`, but with considerably less ty

A nice little addition from the `mobx` team. It brings `redux`-like state trees, immutability, and type guarantees. Love it.


## Keyboard Support

> **mousetrap**
Expand All @@ -51,6 +53,7 @@ The main menu in electron has keyboard accelators, but we still need one in the

Mousetrap fills that gap. It's a pretty decent little library despite not being maintained any more (lol@js). Does the job though. I've tried a couple of others but keep coming back to this one.


## Utilities

> **ramda**
Expand All @@ -76,6 +79,7 @@ A few quality-of-life utilities for working in Electron.

Persist JSON to the file system.


## Bundler

> **fuse-box**
Expand Down
6 changes: 2 additions & 4 deletions docs/using.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@
Want to try this out? Clone & run. There's a small sample project included.

```sh
git clone [email protected]:skellock/electron-starter.git
git clone --depth 1 [email protected]:skellock/electron-starter.git
cd electron-starter
npm i
npm start
```

_Requires `node@>=8.1` and `npm@>=5.2`._

_Requires `node@>=8.2` and `npm@>=5.3`._ (NOTE: not really, but ya, upgrade ... there's some pretty big bugs in earlier versions)

## Start Your Own Project

Expand All @@ -29,7 +28,6 @@ You can keep the Electron parts but lose the rendering opinions.

* delete the directories under `src/renderer`
* change `src/renderer/index.tsx` to point to your new component
* remove `rebass` from `package.json`


## Keep the Meat, Ditch the Fluff
Expand Down
Loading