https://github.com/buttercms/storybook-component-testing
Component Testing with Storybook and ButterCMS
https://github.com/buttercms/storybook-component-testing
Last synced: 4 months ago
JSON representation
Component Testing with Storybook and ButterCMS
- Host: GitHub
- URL: https://github.com/buttercms/storybook-component-testing
- Owner: ButterCMS
- Created: 2022-01-20T18:00:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-20T15:50:08.000Z (over 3 years ago)
- Last Synced: 2026-01-29T22:35:47.012Z (5 months ago)
- Language: JavaScript
- Size: 175 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Component Testing with Storybook and ButterCMS
## Important Notice
This project was created as an example use case of ButterCMS in conjunction with a blog article, [Component Testing with Storybook and ButterCMS](https://buttercms.com/blog/component-testing-with-storybook/), using React and Storybook, and will not be actively maintained.
If you’re interested in exploring the best, most up-to-date way to integrate Butter into javascript frameworks like React, you can check out the following resources:
### Starter Projects
The following turn-key starters are fully integrated with dynamic sample content from your ButterCMS account, including main menu, pages, blog posts, categories, and tags, all with a beautiful, custom theme with already-implemented search functionality. All of the included sample content is automatically created in your account dashboard when you sign up for a free trial of ButterCMS.
- [Angular Starter](https://buttercms.com/starters/angular-starter-project/)
- [React Starter](https://buttercms.com/starters/react-starter-project/)
- [Vue.js Starter](https://buttercms.com/starters/vuejs-starter-project/)
- Or see a list of all our [currently-maintained starters](https://buttercms.com/starters/). (Over a dozen and counting!)
### Other Resources
- Check out the [official ButterCMS Docs](https://buttercms.com/docs/)
- Check out the [official ButterCMS API docs](https://buttercms.com/docs/api/)
## Article
[Link to detailed article about how this was developed](https://buttercms.com/blog/component-testing-with-storybook).
## Requirements
1. [Node.js](https://nodejs.org/)
2. [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
## Installation
### 1. **Clone the application**
```sh
git clone git@github.com:ButterCMS/storybook-component-testing.git
```
### 2. **Install necessary dependencies for the application**
```sh
yarn install
```
### 3. **Start the frontend application**
From the root directory, we can run the following command to start our frontend application:
```sh
yarn dev
```
The above command will start the frontend application on [http://localhost:3000](http://localhost:3000).
### 4. **Start the Storybook application**
From the root directory, we can run the following command to start our Storybook application:
```sh
yarn storybook
```
The above command will start the frontend application on [http://localhost:6006](http://localhost:6006).