Giter Club home page Giter Club logo

storybook-genie's Introduction

Storybook Genie


Storybook Genie is a command line interface tool that can be used to convert files that contain React components into Storybook stories.



Project license Contributors Issue PRs Stars

๐ŸŒŸ Features

  • File selection input
  • JS beautify
  • A small number of dependencies

๐Ÿ“ฆ Installation

To install the storybook-genie package, run the following command:

npm install storybook-genie

๐Ÿ› ๏ธ Configuration

In order to use this package, you need to set your OpenAI API key as an environment variable. You can do this by adding the following line to your .env file, or by setting it directly in your terminal:

For Unix-based systems:

export OPENAI_API_KEY=$YOUR_API_KEY

For Windows systems:

set OPENAI_API_KEY=$YOUR_API_KEY

โœจ Usage

To use Storybook Genie, run the following command:

npx storybook-genie

๐ŸŒฑ Getting Started

Clone the repository:

git clone https://github.com/eduardconstantin/storybook-genie.git

Install dependencies:

npm install

Input your OPENAI API key in the .env file, you can get your API key here:

OPENAI_API_KEY=$YOUR_API_KEY

Run the CLI:

npm run start

You will be prompted to select a file and then press enter. The generator will create a ".story.js" file in the same folder.

๐Ÿ‘ฅ Contributing

I welcome feedback and contributions from other developers, which can help improve the quality of the code and the application overall.

In order to create an issue or a pull request with your changes, please read our contribution guidelines, and thank you for being involved!

For a full list of all authors and contributors, see the contributors page.

๐Ÿ“œ License

This project is licensed under the MIT License - see the LICENSE file for details.

storybook-genie's People

Contributors

eduardconstantin avatar datsfilipe avatar dependabot[bot] avatar hayawata3626 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.