React Presentational React Components
Boilerplate for reusable and declouped presentational react components.
The main idea of this project was based on develop decoupled components in a isolated environment. We don't need to use an entire application to build our components, we just need some place to run and test them.
Node >= 4 npm install
Folders and Files
├── css│ └── main.css├── src│ └── Main.js├── stories│ └── Main.js├── storybook│ ├── config.js│ └── webpack.config.js├── tests│ ├── helpers│ │ └── setup.js│ └── specs│ └── Main.spec.js├── .babelrc├── .editorconfig├── .eslintrc├── .gitignore├── .npmignore├── .travis.yml├── Readme.md└── package.json
Creating your Component
Writing your code
Write your component code on
src/Main.js, you can create another files for composable components also.
;;const Component =<h1>Hello name!</h1>;ComponentpropTypes =name: PropTypesstringisRequired;;
(https://storybook.js.org/basics/guide-react/). Follow the example above:
Every new story will be available on the left side panel of React Storybook to see different cases.
Running your code
npm start, Runs the app in development mode.
Open http://localhost:9001 to view it in the browser.
The page will reload if you make edits and you will see the build errors and lint warnings in the console.
npm test: run your tests in a single-run mode.
npm run test:tdd: run and keep watching your test files.
npm run test:coverage: prints and create html files by istanbul coverage.
Linting your code
npm run lint: lint all files searching for errors.
npm run lint:fix: fix automaticaly some lint errors.
Deploy your component
You can deploy your component (inside Storybook) to
github pages running the command
npm run deploy-storybook.
Why use this?
We believe that start to code shouldn't be hard, so you don't need to concern about configurations and tools, just create your pretty stuff. With this structure, your environment will have everything you need to build a modern React Component:
- React, JSX and ES6 support with Babel.
- A dev server with live reload
- Stack for tests
- A build script to compile and minify for production
What we use?
React Storybook - to tell stories with different behaviors of the component and provide an example page.
- EditorConfig - standardize some general settings among multiple editors
- ESLint - for reporting the patterns of code
This project also uses Husky to prevent to push code with lint errors or broken tests. If you don't want this, you can uninstall running
npm uninstall --save-dev husky and deleting the prepush command on