Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mozilla/neo
INACTIVE - http://mzl.la/ghe-archive - DEPRECATED: See https://neutrino.js.org for alternative
https://github.com/mozilla/neo
inactive unmaintained
Last synced: about 2 months ago
JSON representation
INACTIVE - http://mzl.la/ghe-archive - DEPRECATED: See https://neutrino.js.org for alternative
- Host: GitHub
- URL: https://github.com/mozilla/neo
- Owner: mozilla
- License: mpl-2.0
- Archived: true
- Created: 2016-05-02T21:11:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-29T21:56:34.000Z (over 5 years ago)
- Last Synced: 2024-05-22T18:29:58.112Z (4 months ago)
- Topics: inactive, unmaintained
- Language: JavaScript
- Homepage: https://neutrino.js.org
- Size: 91.8 KB
- Stars: 501
- Watchers: 13
- Forks: 27
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- -awesome-create-react-app - mozilla/neo - Create and build React web applications with zero initial configuration and minimal fuss. (Alternatives)
- awesome-create-react-app - mozilla/neo - Create and build React web applications with zero initial configuration and minimal fuss. (Alternatives)
README
### DEPRECATED!
Please see Neutrino for an alternative!
https://neutrino.js.org
---
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](https://blog.eliperelman.com/neo-8bf3d7325f7)
---
## 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](https://github.com/eliperelman/neo-example).
## Initialize empty project
#### Global
```bash
npm install -g mozilla-neo
mkdir && cd
neo init # and follow the prompts
```
#### Local
```bash
mkdir -p /node_modules && cd
npm install mozilla-neo
node_modules/.bin/neo init # and follow the prompts
```
##### Sample output
```bash
→ create package.json
→ create src/
→ create tests/
→ create .gitignore
→ create .travis.yml
→ create LICENSE
→ create README.md
```
## Install in existing project
```bash
npm install --save-dev mozilla-neo
```
Make changes to configuration by following the [scaffold init guide](https://github.com/mozilla/neo/tree/master/commands/init/templates#configuration).
## 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.7.0
- Support deeply-nested test files in `tests/`
### v2.6.0
- Support importing modules relative to `src/`
- Use `svg-url-loader` for SVGs
### 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](https://github.com/mozilla/neo/issues)
- Source Code: [https://github.com/mozilla/neo](https://github.com/mozilla/neo)
- Code of Conduct: [Adapted from Rust CoC](https://www.rust-lang.org/conduct.html)
Note: There is currently a [bug in npm](https://github.com/npm/npm/issues/13385) 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/](https://neo-slack.herokuapp.com/).
We also have an IRC channel `#neo` on [Mozilla IRC](https://wiki.mozilla.org/IRC).
## License
This project is licensed under the [Mozilla Public License v2.0](https://github.com/mozilla/neo/blob/master/LICENSE)