Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/r100-stack/demo-qwik-itwinui
https://github.com/r100-stack/demo-qwik-itwinui
Last synced: 26 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/r100-stack/demo-qwik-itwinui
- Owner: r100-stack
- Created: 2022-12-26T00:49:47.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T16:42:43.000Z (about 2 years ago)
- Last Synced: 2024-11-08T14:54:27.214Z (3 months ago)
- Language: TypeScript
- Size: 122 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Demo Qwik app with iTwinUI-react
This is a sample repo I created to test adding iTwinUI-react to a [Qwik app](https://qwik.builder.io/). The errors I encountered are listed in [discussion #934](https://github.com/iTwin/iTwinUI/discussions/934) in the [iTwinUI GitHub repo](https://github.com/iTwin/iTwinUI/)
Changes made:
* Ran `npm create qwik@latest` to create a starter Qwik app.
* Ran `npm run qwik add react` as mentioned in the [Qwik React integration docs](https://qwik.builder.io/integrations/integration/react/).
* Installed `@itwin/itwinui-react 2.2.0` from npm.
* Added `IUIIconButton` in `src/integration/react/mui.tsx`
* Used `IUIIconButton` in `src/routes/react/index.tsx`
Below is the default README autogenerated by Qwik:
---
# Qwik City App ⚡️
- [Qwik Docs](https://qwik.builder.io/)
- [Discord](https://qwik.builder.io/chat)
- [Qwik GitHub](https://github.com/BuilderIO/qwik)
- [@QwikDev](https://twitter.com/QwikDev)
- [Vite](https://vitejs.dev/)
---
## Project Structure
This project is using Qwik with [QwikCity](https://qwik.builder.io/qwikcity/overview/). QwikCity is just a extra set of tools on top of Qwik to make it easier to build a full site, including directory-based routing, layouts, and more.
Inside your project, you'll see the following directory structure:
```
├── public/
│ └── ...
└── src/
├── components/
│ └── ...
└── routes/
└── ...
```
- `src/routes`: Provides the directory based routing, which can include a hierarchy of `layout.tsx` layout files, and an `index.tsx` file as the page. Additionally, `index.ts` files are endpoints. Please see the [routing docs](https://qwik.builder.io/qwikcity/routing/overview/) for more info.
- `src/components`: Recommended directory for components.
- `public`: Any static assets, like images, can be placed in the public directory. Please see the [Vite public directory](https://vitejs.dev/guide/assets.html#the-public-directory) for more info.
## Add Integrations and deployment
Use the `npm run qwik add` command to add additional integrations. Some examples of integrations include: Cloudflare, Netlify or Express server, and the [Static Site Generator (SSG)](https://qwik.builder.io/qwikcity/static-site-generation/static-site-config/).
```shell
npm run qwik add # or `yarn qwik add`
```
## Development
Development mode uses [Vite's development server](https://vitejs.dev/). During development, the `dev` command will server-side render (SSR) the output.
```shell
npm start # or `yarn start`
```
> Note: during dev mode, Vite may request a significant number of `.js` files. This does not represent a Qwik production build.
## Preview
The preview command will create a production build of the client modules, a production build of `src/entry.preview.tsx`, and run a local server. The preview server is only for convenience to locally preview a production build, and it should not be used as a production server.
```shell
npm run preview # or `yarn preview`
```
## Production
The production build will generate client and server modules by running both client and server build commands. Additionally, the build command will use Typescript to run a type check on the source code.
```shell
npm run build # or `yarn build`
```