README.md

Redd (Work in Pregress)

Open Source Cross Platform Desktop Client for Reddit Edit

Screenshot

Run

Start the app in the dev environment. This starts the renderer process in hot-module-replacement mode and starts a server that sends hot updates to the renderer process:

$ npm run dev

Run these two commands simultaneously in different console tabs:

$ npm run start-renderer-dev
$ npm run start-main-dev

Editor Configuration

Atom

apm install editorconfig es6-javascript atom-ternjs javascript-snippets linter linter-eslint language-babel autocomplete-modules file-icons

VSCode

• Editorconfig
• ESLint
• Flow
• Babel
• Jest
• ES6 Snippets
• React Snippets 💡 If you are using the flow-for-vscode plugin, make sure to disable the flowtype-errors/show-errors eslint rule in the .eslintrc by setting it to 0

Sublime

• Editorconfig Integration
• Linting
• ESLint Integration
• Syntax Highlighting
• Autocompletion
• Node Snippets
• ES6 Snippets

Others

• Editorconfig
• ESLint
• Babel Syntax Plugin

DevTools

Toggle Chrome DevTools

• OS X: Cmd Alt I or F12
• Linux: Ctrl Shift I or F12
• Windows: Ctrl Shift I or F12

See electron-debug for more information.

DevTools extension

This boilerplate includes the following DevTools extensions:

• Devtron - Install via electron-debug.
• React Developer Tools - Install via electron-devtools-installer.
• Redux DevTools - Install via electron-devtools-installer.

You can find the tabs on Chrome DevTools.

If you want to update extensions version, please set UPGRADE_EXTENSIONS env, just run:

$ UPGRADE_EXTENSIONS=1 npm run dev

# For Windows
$ set UPGRADE_EXTENSIONS=1 && npm run dev

💡 You can debug your production build with devtools by simply setting the DEBUG_PROD env variable:

DEBUG_PROD=true npm run package

Packaging

To package apps for the local platform:

$ npm run package

To package apps for all platforms:

First, refer to Multi Platform Build for dependencies.

Then,

$ npm run package-all

To package apps with options:

$ npm run package -- --[option]

Further commands

To run the application without packaging run

$ npm run build
$ npm start

To run End-to-End Test

$ npm run build
$ npm run test-e2e

Acknowledgement

• https://github.com/chentsulin/electron-react-boilerplate