1.0.0 • Published 6 years ago

generator-redux-saga-material v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

Generator-React-Redux-Saga-MaterialUI

NPM version Build Status Dependency Status

generator-redux-saga-material

A bare-bones yeoman generator built from create-react-app with some additions to make it easy to kick-start and manage projects that use:

  • React for building the UI.
  • Redux for state management.
  • Redux Saga redux middleware for handling side effects.
  • Material-UI for react components based on google's material design.
  • JSS for css in js styling.
  • Immutable JS for immutable data in stores.

Also contains:

  • Linting using eslint
  • Precommit hooks that run the linter.

Installation and usage

Prerequisites:

  • Node.js version >=8.0.0. You can use nvm to manage different node versions.
  • Install yeoman and generator-redux-saga-material globally.
npm install -g yo
npm install -g generator-redux-saga-material

Then to set up a new project:

# Create a directory and cd into it
mkdir web-app && cd web-app

# To create a new project in the current directory, run the generator
yo redux-saga-material

# Start the project
yarn start

# Generating a new component
yo redux-saga-material:component SomeComponentName

# Generating a new container
yo redux-saga-material:container SomeContainerName

Contribute

Contributions are welcome. Create issues for errors and requests, submit PRs against the develop branch.

License

MIT license