Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/RoyRao2333/template-vite-svelte-ts-tailwind

Svelte & Vite boilerplate.
https://github.com/RoyRao2333/template-vite-svelte-ts-tailwind

Last synced: about 2 months ago
JSON representation

Svelte & Vite boilerplate.

Lists

README

        


Vite SVGSvelte SVG

template-vite-svelte-ts-tailwind



## Introduction

A starter [Vite](https://vitejs.dev/) template having:

- [Svelte](https://github.com/sveltejs/svelte)/[SvelteKit](https://github.com/sveltejs/kit)
- [TypeScript](https://github.com/microsoft/TypeScript)
- [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss)
- [Prettier](https://github.com/prettier/prettier)
- [Eslint](https://github.com/eslint/eslint)

> **Note**
>
> This code repository may occasionally update its dependency versions. If the dependency versions in the latest code do not meet your expectations, please go to [Tags](https://github.com/RoyRao2333/template-vite-svelte-ts-tailwind/tags) section to download a previous version of this template. I will display the dependencies used in each Tag, please choose the one you need.
>
> 这个代码仓库可能会不定期更新其依赖包的版本。如果最新代码中依赖的版本不符合你的期望,请移步[Tags](https://github.com/RoyRao2333/template-vite-svelte-ts-tailwind/tags)下载之前的模板。每个Tag中使用的依赖都会展示在Tag详情中,请选择你需要的版本。

## Install

> This project uses [node](http://nodejs.org) and a package manager ([npm](https://npmjs.com), [yarn](https://yarnpkg.com/) or [pnpm](https://pnpm.io/)). Go check them out if you don't have them locally installed.

Then you need a copy of this repository. You can download a copy of [Svelte](https://github.com/RoyRao2333/template-vite-svelte-ts-tailwind/archive/refs/heads/Svelte.zip) or [SvelteKit](https://github.com/RoyRao2333/template-vite-svelte-ts-tailwind/archive/refs/heads/SvelteKit.zip) as zip but [tiged](https://github.com/tiged/tiged) is recommended.

After you installed tiged, please excute the following command:

```sh
$ cd path-to-save-your-project
# If you want a Svelte + Vite project
$ tiged royrao2333/template-vite-svelte-ts-tailwind#Svelte your-project-name
# If you want a SvelteKit project
$ tiged royrao2333/template-vite-svelte-ts-tailwind#SvelteKit your-project-name
```

After getting a copy of the template, you can use your package manager to install dependecies:

```sh
$ cd path-to-your-project
$ pnpm install

# npm install
# yarn install
```

## Usage

Let's run!

```sh
$ pnpm run dev

# npm run dev
# yarn run dev
```

> We've already implemented some recommended configurations in ```.eslintrc.js```, ```.eslintignore```, ```.prettierrc.js``` and ```.prettierignore```. Feel free to edit them if you have your own preferences.

## Contributing

Feel free to dive in! [Open an issue](https://github.com/RoyRao2333/template-vite-svelte-ts-tailwind/issues/new) or submit PRs.

## License

[MIT](LICENSE) © Roy Rao