JavaScript Other
Permalink
Failed to load latest commit information.
app Display arrays a bit more nicely. 📓 Feb 23, 2017
flow-typed/npm Added eslint-plugin-compat support Dec 21, 2016
resources regenerated icns file Oct 10, 2016
test Removed comment from setup.js Dec 15, 2016
.babelrc Add es2015-classes / class-properties plugins only for development (#… Dec 28, 2016
.editorconfig Closes #17, improve .eslintrc Jun 8, 2015
.eslintrc Updated deps Dec 30, 2016
.flowconfig Updated flowconfig settings Oct 7, 2016
.gitattributes Set line endings to use LF instead of auto (git) Nov 11, 2016
.gitignore Initial commit (#641) Dec 30, 2016
.travis.yml Drop node 4 support in favor of modern versions Oct 31, 2016
CHANGELOG.md fix 0.10.0 changelog May 21, 2016
LICENSE Year-agnostic copyright message Jul 10, 2016
README.md Re-add README updates. Feb 21, 2017
appveyor.yml Drop node 4 support in favor of modern versions Oct 31, 2016
erb-logo.png include logos Jul 5, 2015
package.json Update various packages 🐱 Jan 9, 2017
server.js Added flow-typed support Dec 10, 2016
setup.js create additional documentation (both in readme and setup.js) to expl… Nov 2, 2016
webpack.config.base.js Moved styling from production to renderer Dec 2, 2016
webpack.config.development.js Fix devtools debugger Nov 5, 2016
webpack.config.electron.js Build optimizations Dec 15, 2016
webpack.config.eslint.js Fix .eslintrc import/resolver settings Jul 21, 2016
webpack.config.production.js Build optimizations Dec 15, 2016
webpack.config.test.js add comments - webpack configs and dev server Sep 27, 2016
yarn.lock Updated deps Dec 30, 2016

README.md

SHEATH - Ranvier World Viewer and Editor

This is an Electron/React/Redux app being developed alongside Ranvier, a MUD engine written in NodeJS. Eventually, Sheath will be a full-featured world-viewer and editor.

Planned features:

  • Viewing all loaded items, players, NPCs, rooms, and areas.
  • Viewing all definitions of items, NPCs, rooms.
  • Cloning/spawning items, NPCs, and room from definition files.
  • Creating new definitions that will be stored and persisted by the MUD server.
  • ???
  • Profit.

Built with electron-react-boilerplate

Electron application boilerplate based on React, Redux, React Router, Webpack, React Transform HMR for rapid application development

Install

  • Note: requires a node version >= 6 and an npm version >= 3.
  • If you have installation or compilation issues with this project, please see our debugging guide

ProTip: Install with yarn for faster and safer installation

$ cd sheath-ranviermud && npm install

Run

Run these two commands simultaneously in different console tabs.

$ npm run hot-server
$ npm run start-hot

or run two servers with one command

$ npm run dev

Optional Editor Configuration

Atom

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

Sublime

Others

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 is included following DevTools extensions:

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

CSS Modules

This boilerplate out of the box is configured to use css-modules.

All .css file extensions will use css-modules unless it has .global.css.

If you need global styles, stylesheets with .global.css will not go through the css-modules loader. e.g. app.global.css

If you want to import global css libraries (like bootstrap), you can just write the following code in .global.css:

@import "~bootstrap/dist/css/bootstrap.css";

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

Options

See electron-builder CLI Usage

Module Structure

This boilerplate uses a two package.json structure.

  1. If the module is native to a platform or otherwise should be included with the published package (i.e. bcrypt, openbci), it should be listed under dependencies in ./app/package.json.
  2. If a module is imported by another module, include it in dependencies in ./package.json. See this ESLint rule.
  3. Otherwise, modules used for building, testing and debugging should be included in devDependencies in ./package.json.

Static Type Checking

This project comes with Flow support out of the box! You can annotate your code with types, get Flow errors as ESLint errors, and get type errors during runtime during development. Types are completely optional.

Native-like UI

If you want to have native-like User Interface (OS X El Capitan and Windows 10), react-desktop may perfect suit for you.

Dispatching redux actions from main process

see discusses in #118 and #108

How to keep the boilerplate updated

If your application is a fork from this repo, you can add this repo to another git remote:

git remote add upstream https://github.com/chentsulin/electron-react-boilerplate.git

Then, use git to merge some latest commits:

git pull upstream master

Maintainers for Boilerplate

License for Boilerplate

MIT © C. T. Lin