Skip to content

Commit

Permalink
Merge pull request #14 from cwlsn/13-readme-fix
Browse files Browse the repository at this point in the history
Move index mdx file and rename stock README
  • Loading branch information
cwlsn authored Oct 3, 2018
2 parents dc03c73 + bfec000 commit 9276f32
Show file tree
Hide file tree
Showing 4 changed files with 2,317 additions and 439 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<p align="center">
<img src="https://user-images.githubusercontent.com/10063864/45442352-c961ab80-b68f-11e8-84a3-e920f05a313c.png" width={400} alt="Rinse" />
</p>

> Rinse, React, repeat. A boilerplate to build a React component library.
#### To learn how this project was made from scratch, [read the blog post](https://medium.com/@cwlsn/how-to-write-your-own-reusable-react-component-library-a57dc7c9a210)!

## Get Started

To start your own React component library, clone this repository and start your own Git journey!

```bash
$ git clone https://github.com/cwlsn/rinse-react cool-name
$ cd cool-name
$ rm -rf .git
$ git init
```

## Development and Storybook

You can easily develop and interact with your components by using Storybook. To run the local server, simply run:

```bash
$ npm i
$ npm run storybook
```

Navigate to [http://localhost:9001](http://localhost:9001) to view your stories. They should automatically update as you develop.

Storybook will pick up any story from the `stories.js` file in a component folder.

Rinse is currently using the latest technology available, so you may need to update your Node versions to latest to accomodate Babel 7 and Webpack 4.
Loading

0 comments on commit 9276f32

Please sign in to comment.