{"id":13581054,"url":"https://github.com/BuilderIO/qwik-tw-vercel-starter-kit","last_synced_at":"2025-04-06T06:32:26.679Z","repository":{"id":66175185,"uuid":"586480119","full_name":"BuilderIO/qwik-tw-vercel-starter-kit","owner":"BuilderIO","description":"A starter kit for Qwik on Vercel","archived":false,"fork":false,"pushed_at":"2023-05-03T16:19:32.000Z","size":213,"stargazers_count":20,"open_issues_count":0,"forks_count":8,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-11-05T20:46:50.857Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://qwik-tw-vercel-starter-kit.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BuilderIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-01-08T09:48:31.000Z","updated_at":"2024-10-31T23:16:12.000Z","dependencies_parsed_at":"2024-01-16T20:33:28.683Z","dependency_job_id":"9934df17-422d-4bca-bc0f-8b9665774131","html_url":"https://github.com/BuilderIO/qwik-tw-vercel-starter-kit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BuilderIO%2Fqwik-tw-vercel-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BuilderIO%2Fqwik-tw-vercel-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BuilderIO%2Fqwik-tw-vercel-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BuilderIO%2Fqwik-tw-vercel-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BuilderIO","download_url":"https://codeload.github.com/BuilderIO/qwik-tw-vercel-starter-kit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247445652,"owners_count":20939952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T15:01:57.638Z","updated_at":"2025-04-06T06:32:26.392Z","avatar_url":"https://github.com/BuilderIO.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# Qwik City App ⚡️\n\n- [Qwik Docs](https://qwik.builder.io/)\n- [Discord](https://qwik.builder.io/chat)\n- [Qwik GitHub](https://github.com/BuilderIO/qwik)\n- [@QwikDev](https://twitter.com/QwikDev)\n- [Vite](https://vitejs.dev/)\n\n---\n\n## Project Structure\n\nThis project is using Qwik with [QwikCity](https://qwik.builder.io/qwikcity/overview/). 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.\n\nInside your project, you'll see the following directory structure:\n\n```\n├── public/\n│   └── ...\n└── src/\n    ├── components/\n    │   └── ...\n    └── routes/\n        └── ...\n```\n\n- `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](https://qwik.builder.io/qwikcity/routing/overview/) for more info.\n\n- `src/components`: Recommended directory for components.\n\n- `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.\n\n## Add Integrations and deployment\n\nUse the `pnpm qwik add` command to add additional integrations. Some examples of integrations include: Cloudflare, Netlify or Express server, and the [Static Site Generator (SSG)](https://qwik.builder.io/qwikcity/guides/static-site-generation/).\n\n```shell\npnpm qwik add # or `yarn qwik add`\n```\n\n## Development\n\nDevelopment mode uses [Vite's development server](https://vitejs.dev/). During development, the `dev` command will server-side render (SSR) the output.\n\n```shell\nnpm start # or `yarn start`\n```\n\n\u003e Note: during dev mode, Vite may request a significant number of `.js` files. This does not represent a Qwik production build.\n\n## Preview\n\nThe 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.\n\n```shell\npnpm preview # or `yarn preview`\n```\n\n## Production\n\nThe 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.\n\n```shell\npnpm build # or `yarn build`\n```\n\n## Vercel Edge\n\nThis starter site is configured to deploy to [Vercel Edge Functions](https://vercel.com/docs/concepts/functions/edge-functions), which means it will be rendered at an edge location near to your users.\n\n## Installation\n\nThe adaptor will add a new `vite.config.ts` within the `adapters/` directory, and a new entry file will be created, such as:\n\n```\n└── adapters/\n    └── vercel-edge/\n        └── vite.config.ts\n└── src/\n    └── entry.vercel-edge.tsx\n```\n\nAdditionally, within the `package.json`, the `build.server` script will be updated with the Vercel Edge build.\n\n## Production build\n\nTo build the application for production, use the `build` command, this command will automatically run `pnpm build.server` and `pnpm build.client`:\n\n```shell\npnpm build\n```\n\n[Read the full guide here](https://github.com/BuilderIO/qwik/blob/main/starters/adapters/vercel-edge/README.md)\n\n## Dev deploy\n\nTo deploy the application for development:\n\n```shell\npnpm deploy\n```\n\nNotice that you might need a [Vercel account](https://docs.Vercel.com/get-started/) in order to complete this step!\n\n## Production deploy\n\nThe project is ready to be deployed to Vercel. However, you will need to create a git repository and push the code to it.\n\nYou can [deploy your site to Vercel](https://vercel.com/docs/concepts/deployments/overview) either via a Git provider integration or through the Vercel CLI.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBuilderIO%2Fqwik-tw-vercel-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBuilderIO%2Fqwik-tw-vercel-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBuilderIO%2Fqwik-tw-vercel-starter-kit/lists"}