@getcodestory/codestory

CodeStory

A CLI tool to help you discover codebase of your react project and create Storybook like documentation in devtools panel.

How it works

https://www.loom.com/share/3bf9ebbda95a4ef1814893e88aed1421

Install as devDependencies

npm install @getcodestory/codestory --save-dev

Run

npx cs init // only needed for first time run
npx cs start

or can add to package.json of your react project then each time you only need to run "npm run cs" or "yarn cs" to start CodeStory.

"scripts": {
  "cs": "cs start"
}

Install Globally

If you have nodejs installed in your local then all you needed is to run

npm install -g @getcodestory/codestory

Update

npm update -g @getcodestory/codestory

Run

cs init // only needed for first time run
cs start