Skip to content

Latest commit

 

History

History
136 lines (102 loc) · 4.79 KB

README.md

File metadata and controls

136 lines (102 loc) · 4.79 KB
Raw

views stars forks issues license repo-size

SvelteKit Starter Template

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

Features

  • ⚡ SvelteKit - Cybernetically enhanced web apps
  • 🎨 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 timechainlabs/sveltekit-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

In the project directory, you can run:

Script Description
dev Runs the app in the development mode.
build Builds the app for production.
start Runs the built app in the production mode.
preview Builds and serves the app in the production mode.
lint Runs next lint on the project.
check Runs SvelteKit checks.
check:watch Runs SvelteKit checks in watch mode.
fmt:check Checks if the code is formatted with Prettier.
fmt:write Formats the code with Prettier.
prepare Installs husky git hooks.

Folder Structure

.
├── public
│   └── favicon.png
├── src
│   ├── components
│   │   └── tailwind-indicator.svelte
│   ├── lib
│   │   └── utils.ts
│   ├── routes
│   │   ├── +layout.svelte
│   │   └── +page.svelte
│   ├── types
│   │   └── reset.d.ts
│   ├── app.css
│   ├── app.d.ts
│   └── app.html
├── bun.lockb
├── LICENSE
├── package.json
├── postcss.config.js
├── README.md
├── renovate.json
├── svelte.config.js
├── tailwind.config.js
├── tsconfig.json
└── vite.config.ts

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.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributors:

Note: It may take up to 24h for the contrib.rocks plugin to update because it's refreshed once a day.