https://github.com/jofaval/qwik-hello-world
Experimental project to test out Qwik's "first 'official' release", dummy Journal (self-chat-like).
https://github.com/jofaval/qwik-hello-world
experiment javascript journal jsx qwik react tsx typescript
Last synced: 3 months ago
JSON representation
Experimental project to test out Qwik's "first 'official' release", dummy Journal (self-chat-like).
- Host: GitHub
- URL: https://github.com/jofaval/qwik-hello-world
- Owner: jofaval
- Created: 2022-09-23T21:19:34.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-24T22:49:04.000Z (almost 4 years ago)
- Last Synced: 2025-03-29T12:14:09.430Z (over 1 year ago)
- Topics: experiment, javascript, journal, jsx, qwik, react, tsx, typescript
- Language: TypeScript
- Homepage: https://jofaval.github.io/qwik-hello-world/
- Size: 65.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Qwik 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/)
- [Partytown](https://partytown.builder.io/)
- [Mitosis](https://github.com/BuilderIO/mitosis)
- [Builder.io](https://www.builder.io/)
---
## Why am I doing this?
It's just a simple journal to get my hands on how does Qwik handle:
- Mutations
- State management
- Memoization
- Routing
- Typescript compatibility
...And, obviously, to see for myself it's speed and advantages, because it does indeed look very promising.
It's just an experimental project, for fun, to test new technology out.
## Project Structure
Inside of you project, you'll see the following directories and files:
```
├── public/
│ └── ...
└── src/
├── components/
│ └── ...
└── routes/
└── ...
```
- `src/routes`: Provides the directory based routing, which can include a hierarchy of `layout.tsx` layout files, and `index.tsx` files 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
Use the `npm run qwik add` command to add other integrations. Some examples of integrations include as a Cloudflare, Netlify or Vercel server, and the Static Site Generator (SSG).
```
npm run qwik add
```
## Development
Development mode uses [Vite's development server](https://vitejs.dev/). For Qwik during development, the `dev` command will also server-side render (SSR) the output. The client-side development modules loaded by the browser.
```
npm run dev
```
> Note: during dev mode, Vite will request many JS files, which does not represent a Qwik production build.
## Preview
The preview command will create a production build of the client modules, production build of `src/entry.preview.tsx`, and create a local server. The preview server is only for convenience to locally preview a production build, but it should not be used as a production server.
```
npm run preview
```
## Production
The production build should generate the client and server modules by running both client and server build commands. Additionally, the build command will use Typescript run a type check on the source.
```
npm run build
```