• Qwik Docs
• Discord
• Qwik GitHub
• @QwikDev
• Vite
• Partytown
• Mitosis
• Builder.io

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.

Use the npm run qwik add command to add additional integrations. Some examples of integrations include: Cloudflare, Netlify or Vercel server, and the Static Site Generator (SSG).

npm run qwik add # or `yarn qwik add`

Development mode uses Vite's development server. During development, the dev command will server-side render (SSR) the output.

npm run dev # or `yarn dev`

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 locally preview a production build, and it 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. Additionally, 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 to Netlify Edge Functions, which means it will be rendered at an edge location near to your users.

The Netlify CLI can be used to preview a production build locally. To do so: First build your site, then to start a local server, run:

1. install Netlify CLI globally npm i -g netlify-cli
2. Build your site both ssr and client npm run build.
3. Start a local server with npm run serve. In this project, npm run serve uses the netlify dev command to spin up a server that can handle Netlify's Edge Functions locally.
4. Visit https://localhost:8888/ to check out your site.

You can deploy your site to Netlify either via a Git provider integration or through the Netlify CLI. This starter site includes a netlify.toml file to configure your build for deployment.

Once your site has been pushed to your Git provider, you can either link it in the Netlify UI or use the CLI. To link your site to a Git provider from the Netlify CLI, run the command:

netlify link

This sets up continuous deployment for your site's repo. Whenever you push new commits to your repo, Netlify starts the build process..

If you wish to deploy from the CLI rather than using Git, you can use the command:

netlify deploy --build

You must use the --build flag whenever you deploy. This ensures that the Edge Functions that this starter site relies on are generated and available when you deploy your site.

Add --prod flag to deploy to production.