Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solidjs/templates
Vite + solid templates
https://github.com/solidjs/templates
Last synced: 3 days ago
JSON representation
Vite + solid templates
- Host: GitHub
- URL: https://github.com/solidjs/templates
- Owner: solidjs
- Created: 2020-07-12T12:11:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-26T06:26:52.000Z (9 months ago)
- Last Synced: 2024-10-29T18:55:07.850Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.68 MB
- Stars: 442
- Watchers: 5
- Forks: 118
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-solid-js - Solid Templates
README
# Solid Templates (using [vite](https://vitejs.dev/))
This repository holds most of the official starter templates for [vite](https://vitejs.dev/).
You get:
- HMR out of the box
- Minimal bundle size
- All the vite features
### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)
## Get started
Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.
This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.
These templates are meant to be used as is via the [degit](https://github.com/Rich-Harris/degit) utility.
```bash
# Javascript template
$ npx degit solidjs/templates/js my-solid-project
$ cd my-solid-project
$ npm install # or pnpm install or yarn install
```
```bash
# Typescript template
$ npx degit solidjs/templates/ts my-solid-project
$ cd my-solid-project
$ npm install # or pnpm install or yarn install
```
```bash
# Typescript minimal template
$ npx degit solidjs/templates/ts-minimal my-solid-project
$ cd my-solid-project
$ npm install # or pnpm install or yarn install
```
```bash
# Typescript unocss template
$ npx degit solidjs/templates/ts-unocss my-solid-project
$ cd my-solid-project
$ npm install # or pnpm install or yarn install
```
```bash
# Typescript tailwindcss template + basic file base routing
$ npx degit solidjs/templates/ts-router my-solid-project
$ cd my-solid-project
$ npm install # or pnpm install or yarn install
```
```bash
# Typescript bootstrap (5) template
$ npx degit solidjs/templates/ts-bootstrap my-solid-project
$ cd my-solid-project
$ npm install # or pnpm install or yarn install
```
```bash
# Typescript + tailwindcss template
$ npx degit solidjs/templates/ts-tailwindcss my-solid-project
$ cd my-solid-project
$ npm install # or pnpm install or yarn install
```
```bash
# Typescript + sass template
$ npx degit solidjs/templates/ts-sass my-solid-project
$ cd my-solid-project
$ npm install # or pnpm install or yarn install
```
```bash
# Javascript + vitest template
$ npx degit solidjs/templates/js-vitest my-solid-project
$ cd my-solid-project
$ npm install # or pnpm install or yarn install
```
```bash
# Typescript + vitest template
$ npx degit solidjs/templates/ts-vitest my-solid-project
$ cd my-solid-project
$ npm install # or pnpm install or yarn install
```
```bash
# Typescript + uvu template
$ npx degit solidjs/templates/ts-uvu my-solid-project
$ cd my-solid-project
$ npm install # or pnpm install or yarn install
```
## I don't see a template that matches my need?
You wish there was a template with your favorite library?
Feel free to make a pull request. Copy one of the template already available, tweak it, name it properly and make a PR. See [contributing](#contributing) below.
## Contributing
This project is managed with [pnpm](https://pnpm.io). You should [install it](https://pnpm.io/installation) first to test out your template or contribute to an existing one.
You can create your own template and prefix it with `ts-` or `js-` and giving it a name that describe the purpose.
To update all dependencies you can run:
`pnpm up -Lri`
## Troubleshooting
It appears that Webstorm generate some weird triggers when saving a file. In order to prevent that you can follow [this thread](https://intellij-support.jetbrains.com/hc/en-us/community/posts/360000154544-I-m-having-a-huge-problem-with-Webstorm-and-react-hot-loader-) and disable the **"Safe Write"** option in **"Settings | Appearance & Behavior | System Settings"**.