Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simon-he95/vitesse-svelte
vitesse-svelte-starter
https://github.com/simon-he95/vitesse-svelte
Last synced: 2 months ago
JSON representation
vitesse-svelte-starter
- Host: GitHub
- URL: https://github.com/simon-he95/vitesse-svelte
- Owner: Simon-He95
- License: mit
- Created: 2022-12-13T07:51:51.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T10:16:55.000Z (4 months ago)
- Last Synced: 2024-11-24T20:49:35.454Z (3 months ago)
- Language: Svelte
- Homepage:
- Size: 120 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: license
Awesome Lists containing this project
README
## vitesse-svelte
## Try it now!
> Vitesse requires Node >=14.18
### GitHub Template
[Create a repo from this template on GitHub](https://github.com/Simon-He95/vitesse/generate).
### Clone to local
If you prefer to do it manually with the cleaner git history
```bash
npx degit Simon-He95/vitesse-svelte my-vitesse-app
cd my-vitesse-app
pnpm i # If you don't have pnpm installed, run: npm install -g pnpm
```
## Checklist
When you use this template, try follow the checklist to update your info properly
- [ ] Change the author name in `LICENSE`
- [ ] Change the title in `App.vue`
- [ ] Change the hostname in `vite.config.ts`
- [ ] Change the favicon in `public`
- [ ] Remove the `.github` folder which contains the funding info
- [ ] Clean up the READMEs and remove routes
And, enjoy :)
## Usage
### Development
Just run and visit http://localhost:3333
```bash
pnpm dev
```
### Build
To build the App, run
```bash
pnpm build
```
And you will see the generated file in `dist` that ready to be served.
### Deploy on Netlify
Go to [Netlify](https://app.netlify.com/start) and select your clone, `OK` along the way, and your App will be live in a minute.
### Docker Production Build
First, build the vitesse image by opening the terminal in the project's root directory.
```bash
docker buildx build . -t vitesse:latest
```
Run the image and specify port mapping with the `-p` flag.
```bash
docker run --rm -it -p 8080:80 vitesse:latest
```
## Why
I have created several Vite apps recently. Setting the configs up is kinda the bottleneck for me to make the ideas simply come true within a very short time.
So I made this starter template for myself to create apps more easily, along with some good practices that I have learned from making those apps. It's strongly opinionated, but feel free to tweak it or even maintain your own forks. [(see community maintained variation forks)](#variations)
## License
[MIT](./LICENSE) License © 2022 [Simon He](https://github.com/Simon-He95)
