info-card-component
v1.0.0
Published
A info card component created with ReactJs
Downloads
3
Readme
Info Card React Component
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.
Getting Started
Installation
For now, you can clone this repo or use the slush generator. We are creating a CLI 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.
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
├── CONTRIBUTING.md
├── LICENSE.md
├── 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.
import React from 'react';
import PropTypes from 'prop-types';
const Component = ({ name }) => (
<h1>Hello {name}!</h1>
);
Component.propTypes = {
name: PropTypes.string.isRequired,
};
export default Component;
Writing Stories
storiesOf('Component', module)
.add('with lyef name', () => (
<Component name="lyef" />
))
.add('with another name', () => (
<Component name="another" />
))
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
- Linters
- A build script to compile and minify for production
Style Guide
- EditorConfig - standardize some general settings among multiple editors
- ESLint - for reporting the patterns of code