QwikJS is a web development framework that focuses on speed and efficiency, providing developers with tools to create fast and responsive web applications.
- Fast Performance: QwikJS is designed to deliver fast performance, meaning web applications built with this framework can load and run quickly for an optimal user experience.
- Modular architecture: It uses a modular architecture that allows developers to organize their code efficiently, making it easier to scale and maintain applications.
- Reusable Components: QwikJS encourages the creation of reusable components, allowing developers to build consistent and easily maintainable user interfaces.
- Fast Rendering Techniques: Implements fast rendering techniques to update the user interface efficiently, ensuring quick response to user interactions.
- Integration with modern JavaScript: QwikJS integrates with the latest JavaScript features, such as promises and async/await, to simplify asynchronous programming and improve code readability.
- Code size optimization: Cares about the size of the generated code, which can help reduce loading times and improve overall application performance.
- Startup time improvements: QwikJS focuses on reducing the time required for a web application to become interactive after it loads, improving user perception of the speed of the application.
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 oflayout.tsx
layout files, and anindex.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.
Rename the file .env.example to .env and change the environment variables
Use the npm run qwik add
command to add additional integrations. Some examples of integrations includes: Cloudflare, Netlify or Express Server, and the Static Site Generator (SSG).
npm run qwik add # or `yarn qwik add`
Development mode uses Vite's development server. The dev
command will server-side render (SSR) the output during development.
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.
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 preview a production build locally and should not be used as a production server.
npm run preview # or `yarn preview`
The production build will generate client and server modules by running both client and server build commands. The build command will use Typescript to run a type check on the source code.
npm run build # or `yarn build`
This app has a minimal Express server implementation. After running a full build, you can preview the build using the command:
npm run serve
Then visit http://localhost:8080/