Storybook Genie is a command line interface tool that can be used to convert files that contain React components into Storybook stories.
- Select preferred GPT model (OpenAI or Ollama)
- Use local Ollama models (no API key required)
- File selection input
- JS beautify
- Use custom story template
- Change default path
- A s 9696 mall number of dependencies
To install the storybook-genie package, run the following command:
npm install storybook-genieYou can use either OpenAI or Ollama as your AI backend.
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_KEYFor Windows systems:
set OPENAI_API_KEY=$YOUR_API_KEYNo API key is required, but you must have the Ollama server running locally and at least one model pulled (e.g., llama3, mistral, etc.).
Start Ollama:
ollama servePull a model (example):
ollama pull llama3A default model and a default path can be set in storybook-genie.config.json file, just create one in the root of the project and add the following code:
{
"defaultModel": "gpt-4",
"defaultPath": "./components"
}A default story template can be set in storybook-genie.template.js/ts file, just create one in the root of the project.
To use Storybook Genie, run the following command:
npx storybook-genieYou will be prompted to select which API to use (OpenAI or Ollama), then select the model, and then select the files.
Clone the repository:
git clone https://github.com/eduardconstantin/storybook-genie.gitInstall dependencies:
npm installInput your OPENAI API key in the .env file, you can get your API key here:
OPENAI_API_KEY=$YOUR_API_KEYRun the CLI:
npm run startYou will be prompted to select a file and then press enter. The generator will create a ".story.js" file in the same folder.
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.
This project is licensed under the MIT License - see the LICENSE file for details.