Repository files navigation

An opinionated boilerplate for reusable and declouped 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.

For now, you can clone this repo or use theslush generator. We are creating aCLI also.

You’ll need to have Node >= 4 on your machine. We recommend to use Node >= 6 and npm >= 3 for faster installation speed and better disk usage.

├── 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├── CONTRIBUTING.md├── LICENSE.md├── Readme.md└── package.json

Write your component code onsrc/Main.js, you can create another files for composable components also.

importReactfrom'react';importPropTypesfrom'prop-types';constComponent=({ name})=>(<h1>Hello{name}!</h1>);Component.propTypes={name:PropTypes.string.isRequired,};exportdefaultComponent;

Stories are like behavior or states that our components should have. Such as an activated button, labels, whatever your component can change by props/states.

You can also see them as user stories for the agile development.

To understand more about that, I suggest you to read thestorybook stories guide. Follow the example above:

storiesOf('Component',module).add('with lyef name',()=>(<Componentname="lyef"/>)).add('with another name',()=>(<Componentname="another"/>))

Every new story will be available on the left side panel of React Storybook to see different cases.

Just usenpm start, Runs the app in development mode.Openhttp://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.

We encourage everyone to write tests to your components, this can help us to create a more maintainable and free of bugs component. To do that, we create 3 tasks:

• 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.

In order to keep your code clean and consistent we useeslint withAirbnb preset. We have 2 tasks for this:

• npm run lint: lint all files searching for errors.
• npm run lint:fix: fix automaticaly some lint errors.

You can deploy your component (inside Storybook) togithub pages running the commandnpm run deploy-storybook.

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
• Linters
• A build script to compile and minify for production

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
  • Airbnb JavaScript Style Guide
  • Plugins
    • React
    • A11y
    • Import

• Mocha -test framework
• Chai -assertions
• Enzyme -shallow component
• Jsdom -mock the browser

• babel
  • Plugins
    • Airbnb
    • ES2015
    • React

This project useseslint and.editorconfig is defined to have indent_size of4 spaces. You can change that on.eslintrc file.

This project also usesHusky to prevent to push code with lint errors or broken tests. If you don't want this, you can uninstall runningnpm uninstall --save-dev husky and deleting theprepush command onpackage.json.

We'd love to have your helping hand on our lyef-react-component! SeeCONTRIBUTING.md for more information on what we're looking for and how to get started.

MIT License @lyef