Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arrudadev/react-storybook-example
A example of usage of the Storybook in a ReactJs app
https://github.com/arrudadev/react-storybook-example
javascript nextjs reactjs storybook
Last synced: 19 days ago
JSON representation
A example of usage of the Storybook in a ReactJs app
- Host: GitHub
- URL: https://github.com/arrudadev/react-storybook-example
- Owner: arrudadev
- License: mit
- Created: 2022-02-03T00:59:40.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-27T20:08:22.000Z (almost 3 years ago)
- Last Synced: 2024-11-14T15:30:14.356Z (3 months ago)
- Topics: javascript, nextjs, reactjs, storybook
- Language: JavaScript
- Homepage:
- Size: 238 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
React + Storybook
A example of usage of the Storybook in a ReactJs app.
[](https://opensource.org/licenses/MIT)
[](http://makeapullrequest.com)
:pushpin: Table of Contents
* [About The Project](#about-the-project)
* [Technologies](#technologies)
* [Getting Started](#getting-started)
* [Prerequisites](#prerequisites)
* [Installation](#installation)
* [Usage](#usage)
* [Contributing](#contributing)
* [Collaborators](#collaborators)
* [License](#license)
:pencil: About The Project
This project is a small example of the usage the Storybook. Storybook is an open source tool for building UI components and pages in isolation. It streamlines UI development, testing, and documentation. The purpose of this project is to study how to use the Storybook in a React app.
:computer: Technologies
This project was developed with the following technologies:
- [React](https://reactjs.org)
- [Javascript](https://developer.mozilla.org/pt-BR/docs/Web/JavaScript)
- [Storybook](https://storybook.js.org/)
:runner: Getting Started
To run the project locally follow these steps:
:warning: Prerequisites
- [NodeJs](https://nodejs.org/en/) Prefer to install the LTS version.
- [Yarn](https://yarnpkg.com/) Need to install latest version prior to 2.0 version.
:construction_worker: Installation
1. To clone the project, run this command:
```
git clone https://github.com/arrudadev/react-storybook-example.git
```
2. Install dependencies:
```
yarn install
```
:metal: Usage
1. Run the following command to start the Storybook:
```
yarn storybook
```
2. Open the project into your browser in:
```
http://localhost:6006/
```
:tada: Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue. Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)
3. Commit your Changes (`git commit -m 'feat: Add some Amazing Feature'`)
4. Push to the Branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
**After your pull request is merged**, you can safely delete your branch.
For more information read the [Contributing Guidelines](https://github.com/arrudadev/react-storybook-example/blob/main/CONTRIBUTING.md).
:smile: Collaborators
People who contributed to this project.
:page_facing_up: License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
