roalcantara/qwik-app

A simple Qwik demo

qwik-app

A simple Qwik demo app

Install

git clone https://github.com/roalcantara/qwik-app

Dependencies

• git
• gitlint
• pre-commit
• pnpm

Usage

• pnpm start uses Vite's development server to server-side render (SSR) the output
• pnpm preview creates a production build of the client modules and run a local server (a convenience to locally preview a production build)
• pnpm build uses Typescript to run a type check on the source code and generates client and server modules
• pnpm qwik add adds additional integrations

Project Structure

This project is using Qwik with QwikCity. QwikCity is just an 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 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 for more info.

Acknowledgements

• Standard Readme
• Conventional Commits
• Qwik
• Vite
• Unveiling Qwik 1.0

Contributing

• Bug reports and pull requests are welcome on GitHub
• Do follow Editor Config rules.
• Do follow Git lint rules.
• Everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the Contributor Covenant code of conduct.

License

The project is available as open source under the terms of the MIT License