akilism / atomic-choo

A bare minimum project structure to get started developing with electron, webpack & choo.

atomic-choo

An opinionated project seed to get started developing with electron and choo.

• choo a 4kb framework for creating sturdy frontend applications
• choo-persist to synchronize choo state with indexedDB
• lodash/fp a functional programming friendly instance of lodash
• aphrodite a framework-agnostic CSS-in-JS with support for server-side rendering
• css-loader a css loader module for webpack (for loading external css libs)
• eslint a fully pluggable tool for identifying and reporting on patterns in JavaScript

---

Thanks to the power of electron-webpack this template comes packed with:

• webpack-dev-server for development
• HMR for both renderer and main processes
• babel-preset-env to automatically configure babel based on your electron version
• electron-builder to package and build a distributable electron application

Make sure to check out electron-webpack's documentation for more details.

Getting Started

Simply clone down this repository, install dependencies, and get started on your application.

git clone https://github.com/simonwjackson/atomic-choo.git
cd atomic-choo
rm -rf .git
# install dependencies
npm install

Development Scripts

# run application in development mode
npm run dev

# compile source code and create webpack output
npm run compile

# `npm run compile` & create build with electron-builder
npm run dist

# `npm run compile` & create unpacked build with electron-builder
npm run dist:dir