/react-boilerplate-styled-components

Primary LanguageJavaScriptMIT LicenseMIT

Boilerplate for react project

To has facility start project I created this repository.

To create this project I used webpack, storybooks and Jest . You can download or clone this repository. I create a component with test and storybook to have an example.

.
├── config
│   └── ImageStub.js
├── index.js
├── package.json
├── src
│   ├── App.js
│   ├── components
│   │   └── box
│   │       ├── __snapshots__
│   │       │   └── box.spec.js.snap
│   │       ├── box.css.js
│   │       ├── box.spec.js
│   │       ├── box.story.js
│   │       └── index.js
│   ├── css
│   │   └── reset.css.js
│   ├── html
│   │   └── template.html
│   ├── images
│   │   ├── favicon.ico
│   │   └── watermelon-shark.jpg
│   └── index.js
├── webpack
│   ├── webpack.config.js
│   ├── webpack.dev.js
│   └── webpack.prod.js
└── yarn.lock

Project developed with:

  • React;
  • Storybook
  • Jest.

Test developed with:

  • Jest, (back-end e front-end)
  • Storybook - Viewing Components

To run the project you need to install:

  • Node
  • Yarn or NPM (already installed with the node)

Before starting the project you must install the dependencies:

  • $ yarn ou $ npm i

To start the project you have to run the commands:

$ yarn start or $ npm start

If you want to see the test coverage:

$ yarn test or $ npm test

To be able to see the components in Storybook:

$ yarn storybook or $ npm run storybook