README.md

Helps your Electron apps take off quickly 🚀

What is this thing?

ElectroJet is a set of easy-to-use, ready-to-go boilerplates for Electron!

Why do you need a boilerplate in the first place?

Everytime I was struck with an app idea, the thought of setting up frameworks and tooling made me feel very lazy. And I ended up procrastinating. A lot! So, ElectroJet. Electrojet gets my project up and running within one or two minutes!

Why can't you be smart and choose from 100s of other boilerplates?

Flexibility! I wanted to choose between the technologies I wanted. There are lots of boilerplates which pack a crazy ton of shit. Sometimes I wanted more than a boilerplate had to offer, sometimes less. Messing around to add/remove something was even crazier since most boilerplates are of different patterns.

How is this different?

Electrojet is not one but a set of boilerplates. It provides combinations which lets you choose what technologies you want bundled in your boilerplate.

So, what all stuff are there?

Electron and React are available by default in all boilerplates.

Along with them, you can have:

• Redux
  
• React Router
  
• Connected React Router
  
• Redux Persist
  
• Electron Store
  

Build tools:

• Webpack
  
• Babel
  

Other stuff

• ESlint based on Standard JS
  
• React PropTypes
  
• Auto reloading main process with Chokidar
  
• Support for Decorators

Alright. How do I use this?

• Refer the table below to figure out which branch you want.
  
• Clone the corresponding branch with git clone
  git clone --single-branch --branch <branchName> https://github.com/vinaychandranvs/electrojet <yourProjectName>
• Change directory to <yourProjectName>
• Install dependencies by running npm install
• Start development server by runnining npm start
• Package using npm run build

Branch Name	React	Redux	Redux Persist w/ Electron Store	Connected React Router
master	✅	✅	✅	✅
base	✅	❌	❌	❌
redux	✅	✅	❌	❌
redux-persist	✅	✅	✅	❌
react-redux-router	✅	✅	❌	✅