/qwik-typescript-tailwindcss-template

⚡️ Simplistic template for Qwik + TypeScript + Tailwind CSS

Primary LanguageTypeScript

⚡️ qwik-typescript-tailwindcss-template

What's included?

  • Qwik
  • TypeScript
  • Tailwind CSS
  • ESLint
    • Imports rules
    • Prettier rules
  • Prettier
    • Tailwind CSS plugin

Project Structure

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.

Add Integrations

Use 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).

pnpm qwik add

Development

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

pnpm dev

Note: during dev mode, Vite may request a significant number of .js files. This does not represent a Qwik production build.

Preview

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.

pnpm preview

Production

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.

pnpm build

Static Site Generator (Node.js)

pnpm build:server