Repository files navigation

• Qwik Docs
• Discord
• Qwik GitHub
• @QwikDev
• Vite

This project is using Qwik withQwikCity. 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 therouting 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 theVite public directory for more info.

Use thenpm run qwik add command to add additional integrations. Some examples of integrations includes: Cloudflare, Netlify or Express Server, and theStatic Site Generator (SSG).

npm run qwik add# or `yarn qwik add`

Development mode usesVite's development server. Thedev 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 ofsrc/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 starter site is configured to deploy toVercel Edge Functions, which means it will be rendered at an edge location near to your users.

The adaptor will add a newvite.config.ts within theadapters/ directory, and a new entry file will be created, such as:

└── adapters/    └── vercel-edge/        └── vite.config.ts└── src/    └── entry.vercel-edge.tsx

Additionally, within thepackage.json, thebuild.server script will be updated with the Vercel Edge build.

To build the application for production, use thebuild command, this command will automatically runnpm run build.server andnpm run build.client:

npm run build

Read the full guide here

To deploy the application for development:

npm run deploy

Notice that you might need aVercel account in order to complete this step!

The project is ready to be deployed to Vercel. However, you will need to create a git repository and push the code to it.

You candeploy your site to Vercel either via a Git provider integration or through the Vercel CLI.