Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mishankov/vite-svelte-trpc
Vite + Svelte + tRPC template
https://github.com/mishankov/vite-svelte-trpc
fullstack svelte sveltejs template trpc typescript vite
Last synced: 3 months ago
JSON representation
Vite + Svelte + tRPC template
- Host: GitHub
- URL: https://github.com/mishankov/vite-svelte-trpc
- Owner: mishankov
- Created: 2022-12-26T19:52:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-02T07:28:11.000Z (3 months ago)
- Last Synced: 2024-08-02T09:07:34.102Z (3 months ago)
- Topics: fullstack, svelte, sveltejs, template, trpc, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 515 KB
- Stars: 29
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/mishankov/vite-svelte-trpc/actions/workflows/ci.yml)
[](https://madewithsvelte.com/p/vite-svelte-trpc-template/shield-link)
# Vite + Svelte + tRPC
This template should help get you started developing with [Vite](https://vitejs.dev/), [Svelte](https://svelte.dev/) and [tRPC](https://trpc.io/) combo
## Features
- HMR for client code with Vite and automatic build and restart for server with tcx on file changes
- [Vitest](https://vitest.dev/) for unit tests
- [Playwright](https://playwright.dev/) for E2E tests
- [GitHub Actions](https://github.com/features/actions) workflow with build, lint and test steps
- [Dependabot](https://docs.github.com/en/code-security/dependabot/working-with-dependabot) setup to keep dependencies updated
- [Express](https://expressjs.com/) and [sirv](https://github.com/lukeed/sirv) to serve SPA and handle tRPC API calls
## How to work with this template?
### Installation
#### Using `degit`
```bash
npx degit github:mishankov/vite-svelte-trpc my-app
```
#### Using GitHub template
Create repo from this template with "Use this template" button above and clone it
### Install dependencies
```bash
npm i
```
### Start server and client
```bash
npm run dev
```
For HMR support use http://localhost:5173/ link by default. tRPC endpoint is http://localhost:5000/
You can also start client and server separately. Use `npm run dev:server` to start server and `npm run dev:client` to start client
### Testing
Unit test are living in `tests` directory. To execute them, run:
```bash
npm run test
```
E2E UI tests are living in `e2e` directory. To execute them, run:
```bash
npm run e2e
```
### Create and run production build
```bash
npm run build
npm run start
```
## Important points of file structure
- `dist` - client and server build directory
- `e2e` - E2E tests
- `tests` - unit tests
- `src`
- `lib`
- `trpc.ts` - tRPC client setup to use in browser code
- `server`
- `index.ts` - setup for ExpressJS server which combines static files serving and tRPC server
- `trpc.ts` - setup for tRPC server
- `test_data.ts` - test data to showcase basic capabilities of this setup
## Recommended IDE Setup
[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).