Skip to content

Commit

Permalink
chore: better dependency definition
Browse files Browse the repository at this point in the history
  • Loading branch information
itsjavi committed Aug 11, 2023
1 parent bd35a8f commit ef9f19a
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 28 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ pnpm add -D @storylite/storylite vite

> You also need `vite` as a devDependency.
For the next steps, please check the [example React](./packages/examples/react) directory
For the next steps, please check the [example React](https://github.com/itsjavi/storylite/tree/main/packages/examples/react) directory
to learn how to integrate it in your project.

## Roadmap
Expand All @@ -57,7 +57,7 @@ to learn how to integrate it in your project.
- [ ] Zoom in/out
- [ ] Accessibility
- [ ] Multiple resizable viewports (side by side)
- [-] Create `packages/examples` packages
- [ ] Create `packages/examples` packages
- [x] Support React
- [ ] Support other frameworks like Vue, Svelte, Solid, and Qwik.
- Customizable components (props, styles, etc.)
Expand All @@ -69,7 +69,7 @@ to learn how to integrate it in your project.
- [ ] Host in GitHub Pages (build and deploy via GitHub Actions)
- [ ] Better handling of the iframes
- [ ] Better addons API
- [ ] Use redux-toolkit
- [ ] Use redux-toolkit or similar (Zustand?)
- [ ] SSR/SSG frameworks support (Next, Astro, etc)
- [ ] Stories format compatible with Storybook (backwards compatible with SB v6 and v7)
- [ ] Better mobile experience (specially for sidebars and toolbars)
Expand All @@ -84,15 +84,14 @@ to learn how to integrate it in your project.
and/or fixes for Vue, Svelte, Solid, and others is welcome via PRs.
- No support for MDX files, to keep the project simple, but adding support via PRs is welcome as long as it doesn't
add too much complexity.
- Changes to the config file will require a full server restart at the moment.

## Contributing

Contributions are welcome! Please read the [contributing guidelines](./CONTRIBUTING.md) before submitting a PR.
Contributions are welcome! Please read the [contributing guidelines](https://github.com/itsjavi/storylite/tree/main/CONTRIBUTING.md) before submitting a PR.

## License

[MIT License](./LICENSE)
[MIT License](https://github.com/itsjavi/storylite/tree/main/LICENSE)

## Acknowledgements

Expand Down
5 changes: 2 additions & 3 deletions packages/examples/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,11 @@
"dev": "vite --port=7707"
},
"dependencies": {
"@storylite/storylite": "workspace:*",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-router-dom": "^6.15.0"
"react-dom": "^18.2.0"
},
"devDependencies": {
"@storylite/storylite": "workspace:*",
"@types/react": "^18.2.20",
"@types/react-dom": "^18.2.7",
"@vitejs/plugin-react-swc": "^3.3.2",
Expand Down
2 changes: 1 addition & 1 deletion packages/examples/react/vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ export default defineConfig({
},
plugins: [
storylitePlugin({
stories: 'stories/**/*.stories.tsx', // relative to the CWD
stories: 'stories/**/*.stories.tsx', // relative to process.cwd()
}),
react(),
],
Expand Down
12 changes: 4 additions & 8 deletions packages/storylite/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
],
"scripts": {
"build": "tsup",
"dev": "tsup --watch --clean",
"dev": "sleep 10 && tsup --watch --clean",
"lint": "eslint --max-warnings=10 .",
"lint-fix": "eslint --fix .",
"prepublishOnly": "pnpm run build",
Expand All @@ -54,15 +54,14 @@
"@types/node": "^20.4.9",
"@types/react": "^18.2.19",
"@types/react-dom": "^18.2.7",
"@vitejs/plugin-react-swc": "^3.3.2",
"lucide-react": "^0.265.0",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-router-dom": "^6.14.2",
"typescript": "^5.1.6",
"vite": "^4.4.9"
"typescript": "^5.1.6"
},
"peerDependenciesMeta": {
"@vitejs/plugin-react-swc": {
"lucide-react": {
"optional": false
},
"react": {
Expand All @@ -76,9 +75,6 @@
},
"typescript": {
"optional": false
},
"vite": {
"optional": false
}
}
}
Loading

0 comments on commit ef9f19a

Please sign in to comment.