teosz/neo

Create and build React web applications with zero initial configuration and minimal fuss.

Neo bakes in the best-of-the-bunch configurations and setup to make developing React-based sites quicker and easier. It is not just another React boilerplate, rather Neo gives you a single development dependency enabling you to develop, test, and build which let's you hit the ground running.

Neo: Introduction on Medium

Features

React, Redux, React Router
Webpack
ESLint, Babel, ES2015 + modules, Stage 0 preset
Tests and coverage with Karma, Mocha, Chai, and Enzyme
Immutable
Bootstrap 4 and Sass
Travis CI

Requirements

Node.js v4+ and npm

Sample App

To view a sample application which contains the initial output of Neo after running init, check out eliperelman/neo-example.

Initialize empty project

Global

npm install -g mozilla-neo
mkdir <project-name> && cd <project-name>
neo init # and follow the prompts

Local

mkdir -p <project-name>/node_modules && cd <project-name>
npm install mozilla-neo
node_modules/.bin/neo init # and follow the prompts

Sample output

→ create package.json
→ create src/
→ create tests/
→ create .gitignore
→ create .travis.yml
→ create LICENSE
→ create README.md

Install in existing project

npm install --save-dev mozilla-neo

Make changes to configuration by following the scaffold init guide.

Workflow

Add code to src/ and tests to tests/.
Build and watch changes in src/ with npm start.
Lint and build the project with npm run build.
Run tests with npm test.

Changes

v2.3.0

Added support for building projects using Node.js v4+

v2.2.0

Added support for JSON loading

v2.1.0

Removed Elm from being "baked in"
Added support for web workers via worker-loader
Updated a few dependencies

v2.0.0

Removed config/eslint.js in favor of config/eslint.core.js and config/eslint.dev.js
Moved src/app.js into project for easy customization and removal

Contribute

Issue Tracker: https://github.com/mozilla/neo/issues
Source Code: https://github.com/mozilla/neo
Code of Conduct: Adapted from Rust CoC

Note: There is currently a bug in npm from being able to run the npm test command in this repo in development. As a workaround, make sure you are using a npm 3.8.9 or less.

Support

If you are having issues, please let us know.

Join our Slack community at https://neo-slack.herokuapp.com/.

We also have an IRC channel #neo on Mozilla IRC.

License

This project is licensed under the Mozilla Public License v2.0

teosz / neo