@personare/slush-react-component-generator
v6.0.2
Published
A slush generator for create a React component in isolation.
Downloads
14
Readme
React Component Generator
A slush generator for create a React component in isolation
The idea of creating this generator components was based on the design structure them in isolation. Where we believe the web should be built this way. It is customized based on some current needs and preferences of Personare but you can easily change.
Feel free to suggest improvements =]
How we made
To define the structure we use an internal process called DSS (Design Structure Sprint) that through a short sprint it allows us to stay focused and aligned with the solution.
Environment
React Storybook - to tell stories with different behaviors of the component and provide an example page.
Style Guide
- EditorConfig - standardize some general settings among multiple editors
- ESLint - for reporting the patterns of code
Tests
- Jest - test framework
Compiler
The structure
├── .babelrc
├── .editorconfig
├── .eslintrc.json
├── .github
│ ├── ISSUE_TEMPLATE.md
│ └── PULL_REQUEST_TEMPLATE.md
├── .gitignore
├── .scrutinizer.yml | .travis.yml | circle.yml
├── .storybook
│ ├── config.js
│ ├── webpack.config.js
│ └── webpack.dist.config.js
├── README.md
├── contributing.md
├── package.json
├── src
│ ├── MyFirstComponent.css
│ ├── MyFirstComponent.js
│ └── MyFirstComponent.story.js
└── tests
├── MyFirstComponent.test.js
└── mock-browser.js
Installation
- Requirements
After install the requirements, run the following command:
[sudo] npm i -g @personare/slush-react-component-generator
Usage
Create a new folder for your project:
mkdir my-first-component && cd my-first-component
Run the generator:
slush react-component-generator
Team
This generator was made with love by contributors.
Creator
| --- | --- | --- | --- | --- | --- | --- Cauê Alves |
Participated in sprint
| --- | --- | --- | --- | --- | --- | --- Pedro Gustavo | Abilio Bittencourt