🧹 cleanups
This commit is contained in:
59
README.md
59
README.md
@@ -1,51 +1,20 @@
|
||||
# Svelte Routify WindiCSS Vite
|
||||
# @lfk/scanclient
|
||||
|
||||
A starter template for Svelte Application with Typescript, uses Routify file-based router, WindiCSS to compile TailwindCSS and Vite.
|
||||
|
||||
[Svelte](https://svelte.dev)
|
||||
[Routify](https://routify.dev)
|
||||
[Vite](https://vitejs.dev)
|
||||
[WindiCSS](https://windicss.org/)
|
||||
[TypeScript](https://www.typescriptlang.org)
|
||||
|
||||
Kudos to all the respective authors, special thanks to [@jakobrosenberg](https://github.com/jakobrosenberg) and [@dominikg](https://github.com/dominikg).
|
||||
|
||||
## Install
|
||||
## ✒️ Overview
|
||||
This is an API client for @lfk/backend
|
||||
- WebApp built with [Svelte](https://svelte.dev), [WindiCSS](https://windicss.org/) (to compile [TailwindCSS](https://tailwindcss.com/)) and [Vite](https://vitejs.dev).
|
||||
- Served to clients via by `electron`.
|
||||
|
||||
## 🚀 Getting Started
|
||||
```
|
||||
git clone https://github.com/reepolee/svelte-routify-windi-vite.git best-dx
|
||||
cd best-dx
|
||||
npm i
|
||||
npm run dev
|
||||
yarn
|
||||
```
|
||||
## Run in electron
|
||||
```
|
||||
yarn electron:dev
|
||||
```
|
||||
|
||||
## SSG
|
||||
|
||||
For SSG you can use [Spank](https://github.com/roxiness/spank):
|
||||
|
||||
# Package electron
|
||||
```
|
||||
npm run build
|
||||
npx spank
|
||||
```
|
||||
|
||||
Ignore error messages about deleting temp files on Windows.
|
||||
|
||||
`dist` folder now contains predrendered pages. It renders pages automatically from Routify config. To serve, just run
|
||||
|
||||
```
|
||||
npx spassr
|
||||
```
|
||||
|
||||
Your web app is now served at port 5000 on localhost.
|
||||
|
||||
Upload `dist` to any web server or JAMstack service like Netlify, Vercel or Cloudflare and you're good to go.
|
||||
|
||||
## VS Code IntelliSense.
|
||||
|
||||
Install the official WindiCSS VS Code plugin for better experience.
|
||||
|
||||
[WindiCSS Extension](https://marketplace.visualstudio.com/items?itemName=voorjaar.windicss-intellisense)
|
||||
|
||||
## WORK IN PROGRESS
|
||||
|
||||
Please mind this is an **experimental** template, based on pre-production versions of ViteJS and WindiCSS. It was born out of frustration with slow development experience of other bundlers and compilers, but as technology changes, I might change my focus away from any of used packages.
|
||||
yarn electron:pack
|
||||
```
|
||||
Reference in New Issue
Block a user