Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fboulnois/sveltekit-template
A SvelteKit 2 and Tailwind CSS template with a few other defaults.
https://github.com/fboulnois/sveltekit-template
eslint playwright postcss prettier svelte sveltekit sveltekit-tailwindcss sveltekit-template tailwindcss typescript vitest
Last synced: 1 day ago
JSON representation
A SvelteKit 2 and Tailwind CSS template with a few other defaults.
- Host: GitHub
- URL: https://github.com/fboulnois/sveltekit-template
- Owner: fboulnois
- License: mit
- Created: 2023-06-16T02:10:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-27T23:59:00.000Z (about 1 month ago)
- Last Synced: 2024-10-11T18:11:41.439Z (25 days ago)
- Topics: eslint, playwright, postcss, prettier, svelte, sveltekit, sveltekit-tailwindcss, sveltekit-template, tailwindcss, typescript, vitest
- Language: JavaScript
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sveltekit-template
A [SvelteKit 2](https://kit.svelte.dev/) template with a few other defaults:
- [Tailwind CSS](https://tailwindcss.com/) for rapid UI development
- [TypeScript](https://www.typescriptlang.org/) for type annotations
- [ESLint](https://eslint.org/) for code linting
- [Prettier](https://prettier.io/) for code formatting
- [Vitest](https://vitest.dev/) for unit testing
- [Playwright](https://playwright.dev/) for browser testing
## Quickstart
This repository can be cloned using `degit`:
```sh
# clone `sveltekit-template` into the `my-app` directory
pnpm dlx degit fboulnois/sveltekit-template my-app
```
## Creating this project
> Skip this step. This step was already run and is kept for posterity.
This project was created using [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
The following steps were run to create this project:
```sh
# create a new sveltekit project in the `sveltekit-template` directory
pnpm create svelte sveltekit-template
# add tailwindcss as a postcss plugin
pnpm add -D autoprefixer postcss prettier-plugin-tailwindcss tailwindcss
```
See the [project history](https://github.com/fboulnois/sveltekit-template/commits/main) for other changes.
## Developing
Install the dependencies using `pnpm install`.
To check the code for issues when developing:
```sh
pnpm format
pnpm lint
pnpm check
pnpm audit
```
To start a development server:
```sh
pnpm dev
```
## Testing
Unit tests are run using [Vitest](https://vitest.dev/). To run unit tests:
```sh
pnpm test
```
End-to-end tests are run using [Playwright](https://playwright.dev/). Install the Playwright dependencies:
```sh
pnpm exec playwright install
pnpm exec playwright install-deps
```
To run end-to-end tests:
```sh
pnpm e2e
```
## Building
To create a production version of the app:
```sh
pnpm build
```
The production build can be previewed with `pnpm preview`.
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.