rajput-hemant / qwik-template Goto Github PK

View Code? Open in Web Editor NEW

A Qwik City template with TypeScript, TailwindCSS, Qwickest Icons and pre-configured with ESLint, Prettier and Husky git hooks.

License: MIT License

JavaScript 10.22% Shell 0.72% TypeScript 88.79% CSS 0.28%

qwik-template's Introduction

Qwik Starter Template ⚡️

A Minimal Qwik City Starter Template with TypeScript, Tailwind CSS, and pre-configured with ESLint, Prettier, and Husky.

Features

⚡ Qwik - Deliver instant apps at scale, Build instantly-interactive web apps without effort.
🎨 Tailwind CSS - A Utility-First CSS Framework for Rapid UI Development
📦 TypeScript - A typed superset of JavaScript that compiles to plain JavaScript
📝 ESLint - The pluggable linting utility for JavaScript and JSX
🛠 Prettier - An opinionated code formatter
🐶 Husky - A tool that makes Git hooks easy
🚫 lint-staged - Run linters against staged git files
📄 commitlint - Lint commit messages
📦 bun - A JavaScript runtime w/ Fast, disk space efficient package manager

Getting Started

Install degit globally

bun i -g degit || pnpm i -g degit || yarn global add degit || npm i -g degit

Create a new project from this template

degit rajput-hemant/qwik-template <project-name>
cd <project-name>

Install dependencies

bun i || pnpm i || yarn || npm i

Initialize a new git repository (Optional):

git init
git add .
git commit --no-verify -m "init"

Available Scripts

Check out the package.json for all available scripts.

After Installation Checklist

Update package.json with your project details.
Update README.md with your project details.
Update LICENSE with your name and year.

Switching Package Manager

This template uses bun as the default package manager. If you want to use pnpm, npm or yarn, you need to remove the bun.lockb file and run pnpm i, npm i or yarn to generate the lock file for the respective package manager.