dcowan/dokku_test_deploy
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

update README
Some checks failed
continuous-integration/drone/push Build is failing
Details

Browse source
This commit is contained in:
Dovi Cowan 2023-02-21 12:21:25 +00:00
parent cec3f14243
commit 1da15f3000
Signed by: dcowan
GPG key ID: C110D77558FBC227
1 changed files with 8 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
README.md
View file

@ -1,49 +1,14 @@
# Svelte + Vite
# Deploy a Svelte app on Dokku with DroneCI
[![Build Status](https://droneci.fnukhosting.net/api/badges/dcowan/dokku_test_deploy/status.svg?ref=refs/heads/main)](https://droneci.fnukhosting.net/dcowan/dokku_test_deploy)
This template should help get you started developing with Svelte in Vite.
This repository is a test for deploying a Svelte app on [Dokku](https://dokku.com/) with DroneCI.
## Recommended IDE Setup
This is a simple Svelte+Vite template app (created with `npm init vite`). The only files that have been changed are:
* `README.md`
* `.drone.yml`
* `.static`
[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).
The pipeline connects to a [self-hosted Dokku server](https://dokku.com/docs/getting-started/installation/) over `ssh` via a local jump host. It configures the new app via the `dokku` CLI tool, deploys the app to Dokku via `git`, then requests a LetsEncrypt SSL certificate for the site.
## Need an official Svelte framework?
Check out [SvelteKit](https://github.com/sveltejs/kit#readme), which is also powered by Vite. Deploy anywhere with its serverless-first approach and adapt to various platforms, with out of the box support for TypeScript, SCSS, and Less, and easily-added support for mdsvex, GraphQL, PostCSS, Tailwind CSS, and more.
## Technical considerations
**Why use this over SvelteKit?**
- It brings its own routing solution which might not be preferable for some users.
- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.
This template contains as little as possible to get started with Vite + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.
Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.
**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?**
Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information.
**Why include `.vscode/extensions.json`?**
Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.
**Why enable `checkJs` in the JS template?**
It is likely that most cases of changing variable types in runtime are likely to be accidental, rather than deliberate. This provides advanced typechecking out of the box. Should you like to take advantage of the dynamically-typed nature of JavaScript, it is trivial to change the configuration.
**Why is HMR not preserving my local component state?**
HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/rixo/svelte-hmr#svelte-hmr).
If you have state that's important to retain within a component, consider creating an external store which would not be replaced by HMR.
```js
// store.js
// An extremely simple external store
import { writable } from 'svelte/store'
export default writable(0)
```
The same pipeline should work with no modification for any static site generator which uses `npm build` to build the site. Dokku will look for the compiled site in `dist/`.