Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryanccollins/slush-react-generator
Generator for the React Redux simple starter project. Scaffolding and component Generation.
https://github.com/ryanccollins/slush-react-generator
Last synced: about 2 months ago
JSON representation
Generator for the React Redux simple starter project. Scaffolding and component Generation.
- Host: GitHub
- URL: https://github.com/ryanccollins/slush-react-generator
- Owner: RyanCCollins
- License: mit
- Created: 2016-07-23T19:27:44.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-09-09T22:42:18.000Z (over 8 years ago)
- Last Synced: 2024-09-19T00:37:17.666Z (3 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/slush-react-generator
- Size: 67.4 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Notice
This project will no longer be updated, in favor of focusing my efforts on the [Scalable React Boilerplate](https://github.com/RyanCCollins/scalable-react-boilerplate) and [Generator Scalable React](https://github.com/RyanCCollins/slush-generator-scalable-react). Feel free to keep using it!
# Slush React-generator [](https://travis-ci.org/ryanccollins/slush-react-generator) [](http://badges.enytc.com/for/npm/slush-react-generator)
> React redux generator for automating tedious react component setup, integrated with the [React Redux Simple Starter](https://github.com/RyanCCollins/react-redux-simple-starter) project.
Note: If you're looking for a project that is a bit more opinionated and feature-rich, the [Scalable React Boilerplate](https://github.com/RyanCCollins/scalable-react-boilerplate) takes the feature-first approach. Along with component generators, the scalable-react-boilerplate project serves as a starting place for building scalable apps and component libraries.
## Getting Started
Install `slush-react-generator` globally:
```bash
$ npm install -g slush-react-generator
```
### Usage
Create a new folder for your project:
```bash
$ mkdir my-slush-react-generator
```
Run the generator from within the new folder:
```bash
$ cd my-slush-react-generator && slush react-generator
```
### Generators
The following generators are provided for usage with React
- Stateless Functional Components
```
npm run gen:component
```
- Containers
```
npm run gen:container
```
The generators will create new folders within the component and container directories respectively, along with a accompanying .scss file.
Coming soon, there will be generators for:
- Action Creators
- Reducers
- Tests
### File Structure
* Some files left out for brevity. Please reference the files in the [React Redux Simple Starter](https://github.com/RyanCCollins/react-redux-simple-starter) project for information about the file structure.
```
.
├── README.md
├── LICENSE
├── index.html
├── package.json
├── webpack.config.js
├── app/
| ├── fonts
| ├── images
| ├── src
| | ├── actions
| | ├── components
| | | ├── MyComponent
| | | ├── MyOtherComponent
| | | ├── App.js
| | | ├── Main.js
| | | └── index.js
| | ├── containers
| | | ├── MyContainer
| | | └── index.js
| | ├── pages
| | ├── reducers
| | ├── store
| | ├── utils
| | └── index.js
| ├── styles
| └── tests
| | ├── actions
| | ├── components
| | ├── reducers
| | └── test_helper.js
├── .eslintignore
├── .eslintrc
├── .gitattributes
└── .gitignore
```
## Getting To Know Slush
Slush is a tool that uses Gulp for project scaffolding.
Slush does not contain anything "out of the box", except the ability to locate installed slush generators and to run them with liftoff.
To find out more about Slush, check out the [documentation](https://github.com/slushjs/slush).
## Contributing
See the [CONTRIBUTING Guidelines](https://github.com/ryanccollins/slush-react-generator/blob/master/CONTRIBUTING.md)
## Support
If you have any problem or suggestion please open an issue [here](https://github.com/ryanccollins/slush-react-generator/issues).
## Timeline / Todos
* [x] Add stateless functional component and container generators
* [x] Migrate to feature-first architecture
* [ ] Add reducer and action creator generators
* [ ] Add test generators
* [ ] Add documentation for generators
## License
The MIT License
Copyright (c) 2016, Ryan Collins
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.