diff --git a/README.md b/README.md index 7a320a2..ae9ee32 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,78 @@ -# Vite templates for Solid +# Solid templates using [vite](https://vitejs.dev/) -This repository holds most of the official starter templates for Vite. +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.. +- All the vite features -## Install +## Get started -Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -i --latest`. -This is the reason you see a `pnpm-lock.yaml`. This is my favorite package manager because it's fast and doesn't bloat the `node_modules` folder. +Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -Lri`. -Note that any package manager should work. I'd just advice you to remove the `pnpm-lock.yml` file before doing an install via your package manager of choice. +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 amoutonbrady/vite-template-solid/js my-solid-project +$ npx degit solidjs/templates/js my-solid-project $ cd my-solid-project -$ pnpm install # or npm install or yarn install +$ npm install # or pnpm install or yarn install ``` ```bash # Typescript template -$ npx degit amoutonbrady/vite-template-solid/ts my-solid-project +$ npx degit solidjs/templates/ts my-solid-project $ cd my-solid-project -$ pnpm install # or npm install or yarn install +$ npm install # or pnpm install or yarn install ``` ```bash # Typescript minimal template -$ npx degit amoutonbrady/vite-template-solid/ts-minimal my-solid-project +$ npx degit solidjs/templates/ts-minimal my-solid-project $ cd my-solid-project -$ pnpm install # or npm install or yarn install +$ npm install # or pnpm install or yarn install ``` ```bash -# Typescript tailwind template -$ npx degit amoutonbrady/vite-template-solid/ts-tailwind my-solid-project +# Typescript windicss template +$ npx degit solidjs/templates/ts-windicss my-solid-project $ cd my-solid-project -$ pnpm install # or npm install or yarn install +$ npm install # or pnpm install or yarn install ``` ```bash -# Typescript tailwind template + basic file base routing -$ npx degit amoutonbrady/vite-template-solid/ts-router my-solid-project +# Typescript windicss template + basic file base routing +$ npx degit solidjs/templates/ts-router my-solid-project $ cd my-solid-project -$ pnpm install # or npm install or yarn install +$ npm install # or pnpm install or yarn install ``` ```bash # Typescript bootstrap (5) template -$ npx degit amoutonbrady/vite-template-solid/ts-bootstrap my-solid-project +$ npx degit solidjs/templates/ts-bootstrap my-solid-project $ cd my-solid-project -$ pnpm install # or npm install or yarn install +$ 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 a router? Bootstrap? Your favorite library? +You wish there was a template with your favorite library? -Feel free to make a pull request. Copy on of the template already available, tweak, name it properly and make a PR. +Feel free to make a pull request. Copy on 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.js.org/). You should [install it](https://pnpm.js.org/install) 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 -r -L` +`pnpm up -Lri` ## Troubleshooting diff --git a/js/README.md b/js/README.md index eb7540a..05f9223 100644 --- a/js/README.md +++ b/js/README.md @@ -1,19 +1,18 @@ ## Usage -Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -i --latest`. -This is the reason you see a `pnpm-lock.yaml`. This is my favorite package manager because it's fast and doesn't bloat the `node_modules` folder. +Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -Lri`. -Note that any package manager should work. I'd just advice you to remove the `pnpm-lock.yml` file before doing an install via your package manager of choice. +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. ```bash -$ pnpm install # or npm install or yarn install +$ npm install # or pnpm install or yarn install ``` ## Available Scripts In the project directory, you can run: -### `npm start` +### `npm dev` or `npm start` Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. diff --git a/js/package.json b/js/package.json index f847438..76a8dd7 100644 --- a/js/package.json +++ b/js/package.json @@ -1,12 +1,13 @@ { "name": "vite-template-solid", "version": "0.0.0", - "description": "My solid + vite project", + "description": "", "scripts": { "start": "vite", + "dev": "vite", "build": "vite build" }, - "license": "ISC", + "license": "MIT", "devDependencies": { "vite": "^2.3.8", "vite-plugin-solid": "^2.0.0-rc.4" diff --git a/ts-bootstrap/README.md b/ts-bootstrap/README.md index d307303..05f9223 100644 --- a/ts-bootstrap/README.md +++ b/ts-bootstrap/README.md @@ -1,19 +1,18 @@ ## Usage -Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -i --latest`. -This is the reason you see a `pnpm-lock.yaml`. This is my favorite package manager because it's fast and doesn't bloat the `node_modules` folder. +Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -Lri`. -Note that any package manager should work. I'd just advice you to remove the `pnpm-lock.yml` file before doing an install via your package manager of choice. +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. ```bash -$ pnpm install # or npm install or yarn install +$ npm install # or pnpm install or yarn install ``` ## Available Scripts In the project directory, you can run: -### `npm run dev` +### `npm dev` or `npm start` Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. diff --git a/ts-bootstrap/package.json b/ts-bootstrap/package.json index d191983..15f5211 100644 --- a/ts-bootstrap/package.json +++ b/ts-bootstrap/package.json @@ -1,12 +1,12 @@ { "name": "vite-template-solid", "version": "0.0.0", - "description": "My solid + vite project + ts", + "description": "", "scripts": { "dev": "vite", "build": "vite build" }, - "license": "ISC", + "license": "MIT", "devDependencies": { "sass": "^1.35.1", "vite": "^2.3.8", diff --git a/ts-minimal/README.md b/ts-minimal/README.md index c9dddca..05f9223 100644 --- a/ts-minimal/README.md +++ b/ts-minimal/README.md @@ -1,18 +1,18 @@ ## Usage -Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -i --latest`. -This is the reason you see a `pnpm-lock.yaml`. This is my favorite package manager because it's fast and doesn't bloat the `node_modules` folder. +Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -Lri`. -Note that any package manager should work. I'd just advice you to remove the `pnpm-lock.yml` file before doing an install via your package manager of choice. +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. ```bash -$ pnpm install # or npm install or yarn install +$ npm install # or pnpm install or yarn install ``` + ## Available Scripts In the project directory, you can run: -### `npm run dev` +### `npm dev` or `npm start` Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. diff --git a/ts-minimal/package.json b/ts-minimal/package.json index 312080f..ccfd1e8 100644 --- a/ts-minimal/package.json +++ b/ts-minimal/package.json @@ -1,12 +1,12 @@ { "name": "vite-template-solid", "version": "0.0.0", - "description": "My solid + vite project + ts", + "description": "", "scripts": { "dev": "vite", "build": "vite build" }, - "license": "ISC", + "license": "MIT", "devDependencies": { "vite": "^2.3.8", "vite-plugin-solid": "^2.0.0-rc.4" diff --git a/ts-router/README.md b/ts-router/README.md index c9dddca..05f9223 100644 --- a/ts-router/README.md +++ b/ts-router/README.md @@ -1,18 +1,18 @@ ## Usage -Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -i --latest`. -This is the reason you see a `pnpm-lock.yaml`. This is my favorite package manager because it's fast and doesn't bloat the `node_modules` folder. +Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -Lri`. -Note that any package manager should work. I'd just advice you to remove the `pnpm-lock.yml` file before doing an install via your package manager of choice. +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. ```bash -$ pnpm install # or npm install or yarn install +$ npm install # or pnpm install or yarn install ``` + ## Available Scripts In the project directory, you can run: -### `npm run dev` +### `npm dev` or `npm start` Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. diff --git a/ts-router/package.json b/ts-router/package.json index e565671..1dfb393 100644 --- a/ts-router/package.json +++ b/ts-router/package.json @@ -1,12 +1,12 @@ { "name": "vite-template-solid", "version": "0.0.0", - "description": "My solid + vite project + ts", + "description": "", "scripts": { "dev": "vite", "build": "vite build" }, - "license": "ISC", + "license": "MIT", "devDependencies": { "vite": "^2.3.8", "vite-plugin-solid": "^2.0.0-rc.4", diff --git a/ts-windicss/README.md b/ts-windicss/README.md index d307303..05f9223 100644 --- a/ts-windicss/README.md +++ b/ts-windicss/README.md @@ -1,19 +1,18 @@ ## Usage -Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -i --latest`. -This is the reason you see a `pnpm-lock.yaml`. This is my favorite package manager because it's fast and doesn't bloat the `node_modules` folder. +Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -Lri`. -Note that any package manager should work. I'd just advice you to remove the `pnpm-lock.yml` file before doing an install via your package manager of choice. +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. ```bash -$ pnpm install # or npm install or yarn install +$ npm install # or pnpm install or yarn install ``` ## Available Scripts In the project directory, you can run: -### `npm run dev` +### `npm dev` or `npm start` Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. diff --git a/ts-windicss/package.json b/ts-windicss/package.json index 5963bdd..14130e8 100644 --- a/ts-windicss/package.json +++ b/ts-windicss/package.json @@ -1,12 +1,12 @@ { "name": "vite-template-solid", "version": "0.0.0", - "description": "My solid + vite project + ts", + "description": "", "scripts": { "dev": "vite", "build": "vite build" }, - "license": "ISC", + "license": "MIT", "devDependencies": { "vite": "^2.3.8", "vite-plugin-solid": "^2.0.0-rc.4", diff --git a/ts/README.md b/ts/README.md index eb7540a..05f9223 100644 --- a/ts/README.md +++ b/ts/README.md @@ -1,19 +1,18 @@ ## Usage -Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -i --latest`. -This is the reason you see a `pnpm-lock.yaml`. This is my favorite package manager because it's fast and doesn't bloat the `node_modules` folder. +Those templates dependencies are maintained via [pnpm](https://pnpm.js.org/) via `pnpm up -Lri`. -Note that any package manager should work. I'd just advice you to remove the `pnpm-lock.yml` file before doing an install via your package manager of choice. +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. ```bash -$ pnpm install # or npm install or yarn install +$ npm install # or pnpm install or yarn install ``` ## Available Scripts In the project directory, you can run: -### `npm start` +### `npm dev` or `npm start` Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser. diff --git a/ts/package.json b/ts/package.json index f764ce0..76a8dd7 100644 --- a/ts/package.json +++ b/ts/package.json @@ -1,12 +1,13 @@ { "name": "vite-template-solid", "version": "0.0.0", - "description": "My solid + vite project + ts", + "description": "", "scripts": { "start": "vite", + "dev": "vite", "build": "vite build" }, - "license": "ISC", + "license": "MIT", "devDependencies": { "vite": "^2.3.8", "vite-plugin-solid": "^2.0.0-rc.4"