Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/storybookjs/native

📱 Storybook for Native: iOS, Android, Flutter
https://github.com/storybookjs/native

Last synced: 4 days ago
JSON representation

📱 Storybook for Native: iOS, Android, Flutter

Host: GitHub
URL: https://github.com/storybookjs/native
Owner: storybookjs
License: mit
Created: 2020-09-02T15:41:01.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-04-24T17:10:55.000Z (7 months ago)
Last Synced: 2024-10-30T00:55:28.818Z (10 days ago)
Language: TypeScript
Homepage:
Size: 4.69 MB
Stars: 187
Watchers: 9
Forks: 28
Open Issues: 16
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-ccamel - storybookjs/native - 📱 Storybook for Native: iOS, Android, Flutter (TypeScript)

README

        # Storybook Native

[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)

Storybook Native is an extension of the normal web storybook that uses [appetize.io](https://appetize.io/) to render your mobile application in an emulator that can be interacted with from your browser. It allows you to use many of the features that are available in the web storybook, such as addons, controls, etc.

![](./images/appetize-emulator.gif)

It also supports using Storybook as a [local development environment](packages/dev-middleware) to develop Android and iOS apps/components, without the need for using appetize.io.

![](./images/local-emulators.gif)

### Installation

Before using this, ensure that you have installed [NodeJS](https://nodejs.org/en/download/)

If you want to use this module to render an emulator as a 

React component, [follow the instructions here](packages/native-components/README.md). This is recommended if you are already familiar with React and Storybook, or if you want to use features such as addons and controls.

If you want to use this module as a build tool that generates stories from metadata, [follow the instructions here](packages/native/README.md). This package supports limited variations of controls generation. This is recommended if you do not want to write any React code, and you will only have to write some basic JavaScript code. If you use this package, you will not have to install any extra Storybook dependencies, as they will already be included.

## Configuring your mobile application

Before using this module, your mobile application must be set up to support switching between stories. There are detailed instructions on this [here](APP-CONFIG.md)

## Uploading your mobile application

After you have modified your application to support launch parameters or query parameters, you must upload your application to [appetize.io](https://appetize.io/). After the upload, you will receive a **public key** that can be used with Storybook Native to view and interact with your application directly from Storybook.

## Setting up Storybook

Once your application is uploaded to appetize.io, you can begin setting up Storybook Native. The details for this can be found [here](./STORYBOOK-CONFIG.md)

### Examples

Examples of how to use this module as both a build tool and as a component library can be found in the [examples folder](examples/). The `app` folder inside each example contains the source code of the application the example is for.

- [Android storybook with controls](https://storybookjs.github.io/native/@storybook/native-controls-example/index.html?path=/story/button--example)

- [Flutter storybook with controls](https://storybookjs.github.io/native/@storybook/native-flutter-example/index.html?path=/story/android--button)

- [Cross platform storybook](https://storybookjs.github.io/native/@storybook/native-cross-platform-example/index.html?path=/story/android--button)

- [iOS storybook with deep linking](https://storybookjs.github.io/native/@storybook/native-ios-example-deep-link/index.html?path=/story/button--example)

More example static storybooks can be found [here](https://storybookjs.github.io/native/)

## Local app development

Details on how to test changes that you make to your mobile application to support features such as controls can be found [here](APP-TESTING.md)

## Migrating from version 1 to version 2

A full migration guide for breaking changes can be found [here](MIGRATION.md)

## Development in this repo

 - Clone this repo

 - Run yarn to install dependencies

 - `yarn build && cd examples/flutter && yarn start`  

 - In a new tab, run `yarn build` whenever changes are made to any of the packages inside of the `packages/` folder

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{Michael Shilman}
📖

    
_{Adil Malik}
💻 📖 💡

    
_{Raj Vasikarla}
📖 💻

    
_imgbot[bot]
💻

    
_brocollie08
📖 💻

    
_{Harris Borawski}
💻

    
_{Josh Halvorson}
💻

  

  

    
_{daisyduong-acc}
💻

    
_{Ahmed na}
📖 💻 💡

    
_{osquitoOfTheNorth}
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!