https://github.com/qwikifiers/qwik-nx
Nx plugin for Qwik
https://github.com/qwikifiers/qwik-nx
Last synced: about 1 year ago
JSON representation
Nx plugin for Qwik
- Host: GitHub
- URL: https://github.com/qwikifiers/qwik-nx
- Owner: qwikifiers
- Created: 2022-11-21T17:06:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-12T10:41:00.000Z (over 1 year ago)
- Last Synced: 2025-05-01T05:37:03.865Z (about 1 year ago)
- Language: TypeScript
- Size: 1.36 MB
- Stars: 135
- Watchers: 4
- Forks: 25
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Qwik Nx Plugin
## install
```
npm install -D qwik-nx
```
## Usage
### Generating a workspace
```
npx create-qwik-nx@latest
```
or
```
npx create-nx-workspace@latest org-workspace --preset=qwik-nx
```
### Generating an application
```
nx generate qwik-nx:app
```
### Generating an library
```
nx generate qwik-nx:lib
```
### Generating a component
```
nx generate qwik-nx:component
```
### Generating a route
```
nx generate qwik-nx:route
```
### Setting up Tailwind CSS
```
nx generate qwik-nx:setup-tailwind
```
### Setting up Deno integration
```
nx generate qwik-nx:deno-integration
```
### Setting up Storybook
```
nx generate qwik-nx:storybook-configuration
```
## Migrations
This plugin supports Nx migrations and provides necessary version and code updates for Qwik. So instead of bumping plugin version manually in package.json it's recommended to run `nx migrate qwik-nx` command, that includes bumping the version of the qwik-nx plugin, related dependencies and running code migrations.
## qwik-nx & Nx Compatibility Chart
| qwik-nx version | Nx version |
| --------------- | ------------------------- |
| ^3.0.0 | ^20.0.0 |
| ^2.0.0 | ^17.0.0, ^18.0.0, ^19.0.0 |
| ^1.1.0 | ^16.8.0 |
| ^1.0.0 | ^16.0.0 |
## ROADMAP:
- [ ] Complete `add-nx-to-qwik`
- [ ] Write missing tests
- [ ] implement more package.json scripts to project.json targets
- [ ] more...
## Contributing
Want to contribute? Yayy! 🎉
Please read and follow our [Contributing Guidelines](CONTRIBUTING.md) to learn what are the right steps to take before contributing your time, effort and code.
Thanks 🙏
## Code Of Conduct
Be kind to each other and please read our [code of conduct](CODE_OF_CONDUCT.md).
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Shai Reznik
💻 ⚠️ 🚇 📖 🚧 👀 🤔
Dmitriy Stepanenko
💻 ⚠️ 🐛 📖 🤔 🚧 📆 👀
John Reemar Dela Rosa
💻 ⚠️ 🐛 📖 🤔 🚧 👀
nait sabes | sebastian®
📖
Sebastian Duque Gutierrez
💻 🤔 ⚠️
Nacho Vazquez
💻 🤔 ⚠️ 📖
Tomas Ptacek
💻 🤔 ⚠️ 📖
Niklas
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## Related Links
- [qwik-nx (and Qwik) Discord](https://qwik.dev/chat)
- [Qwik Docs](https://qwik.dev/)
- [nx](https://nx.dev/)
- [Qwik GitHub](https://github.com/QwikDev/qwik)
- [@QwikDev](https://twitter.com/QwikDev)
## License
MIT
