README
ReactJS-Fullstack Generator
Slush generator for ReactJS - lets you quickly set up a project with sensible defaults and best practices.
Getting Started
Install slush generator
npm install -g slush
Install gulp
npm install -g gulp
Make a new directory, and cd
into it
mkdir my-new-project && cd $_
Install react-fullstack generator
npm install -g slush-react-fullstack
Generate your full app template
slush react-fullstack
Run gulp
to preview on local host, don't forget to spin up an instance of mongo when doing so!
Generators
- react-fullstack (aka react-fullstack:app)
- react-fullstack:endpoint
- react-fullstack:component
- react-fullstack:crud
- react-fullstack:action
- react-fullstack:dispatcher
- react-fullstack:store
To install generators, pick one from the above list:
slush react-fullstack:generator_of_your_choice
Note: Generators are to be run from the root directory of your app.
Testing
Running gulp jest
will run the unit tests with jest.
Contributing
See the contributing docs: CONTRIBUTING.md for instructions.
When submitting a bugfix, write a test that exposes the bug and fails before applying your fix. Submit the test alongside the fix. When submitting a new feature, add tests that cover the feature.
Changelog
Recent changes can be viewed on Github.