diff --git a/README.md b/README.md index 8f12e7e..5f109a2 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,14 @@ ESLint and Prettier are set up in this project, so you may want to install compa More info on setting up in popular editors here: [create-react-app.dev/docs/setting-up-your-editor](https://create-react-app.dev/docs/setting-up-your-editor#displaying-lint-output-in-the-editor) -### Feedback +## Board UI Docs + +We use [Storybook.js](https://storybook.js.org/) to document and test the board components. + +You can view and interact with board components here https://battlesnakeofficial.github.io/board/ + +While developing a component you can run a local copy of storybook with the command `npm run storybook` to view and test it + +## Feedback * **Do you have an issue or suggestions for this repository?** Head over to our [Feedback Repository](https://play.battlesnake.com/feedback) today and let us know! diff --git a/package.json b/package.json index b5d23fe..c97f425 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,7 @@ "lint": "eslint ./src", "lint:fix": "eslint --fix ./src", "storybook": "start-storybook -p 6006 -s public", - "build-storybook": "build-storybook", + "build-storybook": "build-storybook -o ./storybook-static -s public", "build-storybook-ci": "build-storybook -o ./docs -s public" }, "lint-staged": {