Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: remove storybook #49

Merged
merged 3 commits into from
Dec 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
"plugin:@typescript-eslint/recommended",
"plugin:testing-library/react",
"plugin:jest-dom/recommended",
"plugin:prettier/recommended",
"plugin:storybook/recommended"
"plugin:prettier/recommended"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
Expand Down
21 changes: 0 additions & 21 deletions .storybook/main.ts

This file was deleted.

16 changes: 0 additions & 16 deletions .storybook/preview.ts

This file was deleted.

18 changes: 0 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ This starter template includes:
- [Lint Staged](https://github.com/lint-staged/lint-staged) - Format & lint your code before committing, block commit if issues are detected
- [Github Actions](https://docs.github.com/en/actions) - Check, test, and build your code automatically on push and PR
- [Dependabot](https://github.com/dependabot) - Create pull-request to update your dependencies
- [Storybook](https://storybook.js.org/) - Document and test your components in isolated environment
- [Jest](https://jestjs.io/) & [React Testing Library](https://testing-library.com/docs/react-testing-library/intro/) - Unit test your components

### Getting Started
Expand Down Expand Up @@ -72,23 +71,6 @@ You can run unit tests manually on your machine:
pnpm test:cov
```

### Storybook

This starter template comes with Storybook setup out of the box, a library to build, document, and test your components in an isolated environment. It is a great tool where you can share and document your components with your teammates or design team for design system and user experience purposes. [Learn more about Storybook.](https://storybook.js.org/tutorials/intro-to-storybook/react/en/get-started/)

- Run storybook:

```bash
pnpm storybook
```

- Build storybook:
```bash
pnpm storybook:build
```

You don't have to use Storybook in your project if you are building a small project or application. However, it's recommended to use Storybook as a component documentation tool if you are building a large project or application.

### Switching CSS Frameworks / UI Library

"What if I don't want to use Tailwind?"
Expand Down
17 changes: 3 additions & 14 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "react-ts-starter-template",
"version": "1.0.0",
"version": "1.2.0",
"engines": {
"node": ">= 18.x"
},
Expand Down Expand Up @@ -49,16 +49,7 @@
},
"devDependencies": {
"@commitlint/cli": "^18.4.3",
"@commitlint/config-conventional": "^18.4.3",
"@storybook/addon-essentials": "^7.6.2",
"@storybook/addon-interactions": "^7.6.4",
"@storybook/addon-links": "^7.6.4",
"@storybook/addon-onboarding": "^1.0.8",
"@storybook/addon-themes": "^7.6.2",
"@storybook/blocks": "^7.5.3",
"@storybook/react": "^7.5.3",
"@storybook/react-vite": "^7.5.3",
"@storybook/testing-library": "^0.2.2",
"@commitlint/config-conventional": "^18.4.2",
"@testing-library/jest-dom": "^6.1.4",
"@testing-library/react": "^14.1.2",
"@testing-library/user-event": "^14.5.1",
Expand All @@ -80,7 +71,6 @@
"eslint-plugin-react": "^7.33.2",
"eslint-plugin-react-hooks": "^4.6.0",
"eslint-plugin-simple-import-sort": "^10.0.0",
"eslint-plugin-storybook": "^0.6.15",
"eslint-plugin-testing-library": "^6.1.2",
"husky": "^8.0.3",
"identity-obj-proxy": "^3.0.0",
Expand All @@ -92,8 +82,7 @@
"postcss": "^8.4.31",
"prettier": "^3.1.0",
"prettier-plugin-tailwindcss": "^0.5.7",
"storybook": "^7.5.3",
"tailwindcss": "^3.3.6",
"tailwindcss": "^3.3.5",
"ts-jest": "^29.1.1",
"typescript": "^5.3.3",
"vite": "^4.5.0",
Expand Down
Loading