Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tony-stark-eth/vite-svelte-docker-template
Vite Template for running a Svelte App in a Docker Environment
https://github.com/tony-stark-eth/vite-svelte-docker-template
docker svelte vite vitest
Last synced: 25 days ago
JSON representation
Vite Template for running a Svelte App in a Docker Environment
- Host: GitHub
- URL: https://github.com/tony-stark-eth/vite-svelte-docker-template
- Owner: tony-stark-eth
- License: bsd-3-clause
- Created: 2024-09-13T10:58:17.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-09-27T08:15:38.000Z (about 1 month ago)
- Last Synced: 2024-09-29T11:45:36.144Z (about 1 month ago)
- Topics: docker, svelte, vite, vitest
- Language: Shell
- Homepage:
- Size: 359 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-vite - vite-svelte-docker-template - `Docker` + `Svelte` + `Vitest`. (Get Started / Templates)
- fucking-awesome-vite - vite-svelte-docker-template - `Docker` + `Svelte` + `Vitest`. (Get Started / Templates)
README
# Vite Svelte Docker Template
This template offers the following things, ready to use, in a dockerized environment:
- [Vite](https://vitejs.dev/)
- [Svelte 4](https://svelte.dev/) (TypeScript)
- [ESLint](https://www.npmjs.com/package/eslint)
- [Prettier](https://prettier.io/)
- [Svelte-Check](https://www.npmjs.com/package/svelte-check)
- Testing Svelte with [Vitest](https://vitest.dev/) & [Testing Library](https://www.npmjs.com/package/@testing-library/svelte)
## Create with it!
Create with Svelte 4 (default):
```sh
npx degit tony-stark-eth/vite-svelte-docker-template app-name
npx degit tony-stark-eth/vite-svelte-docker-template#[email protected] svelte4-app-name
```
Create with Svelte 5 (experimental):
```sh
npx degit bavragor/vite-svelte-docker-template#release@svelte5 svelte5-app-name
```
## Requirements
- Docker
- make
## Installation
```sh
make setup
make up
make install
```
## Development
```sh
docker compose exec app pnpm run dev
```
## Build
```sh
docker compose exec app pnpm run build
```
## Preview
```sh
docker compose exec app pnpm run preview
```
## Test
```sh
docker compose exec app pnpm run test
```
Or with coverage in build directory
```sh
docker compose exec app pnpm run test:coverage
```
## OS specific settings
### Windows + WSL2 + Symlinks + PNPM
In case your running a setup like me,
WSL2 with Ubuntu and have your IDE running on Windows,
your IDE may not be able to use symlinks created by pnpm.
For this scenario you can do the following
```
cp .npmrc.dist .npmrc
make build
make up
make install
```
This will run pnpm without symlinks.
## Git Hooks
This template also supports git hooks to ensure code quality and consistency before commits and pushes.
These can be activated with:
```
make git-enable-hooks
```
Or deactivated with:
```
make git-disable-hooks
```