https://github.com/aaronksaunders/svelte-sqlite-capacitor
This template should help get you started developing with Svelte and TypeScript in Vite, building mobile applications or web sites with SQLite
https://github.com/aaronksaunders/svelte-sqlite-capacitor
capacitor capacitor-plugin mobile-app pwa-app sqlite svelte
Last synced: 10 months ago
JSON representation
This template should help get you started developing with Svelte and TypeScript in Vite, building mobile applications or web sites with SQLite
- Host: GitHub
- URL: https://github.com/aaronksaunders/svelte-sqlite-capacitor
- Owner: aaronksaunders
- Created: 2024-12-30T03:38:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-30T03:40:55.000Z (about 1 year ago)
- Last Synced: 2025-04-13T04:53:25.699Z (10 months ago)
- Topics: capacitor, capacitor-plugin, mobile-app, pwa-app, sqlite, svelte
- Language: Swift
- Homepage:
- Size: 464 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Svelte + TS + Vite + Capacitor + SQLite
This template should help get you started developing with Svelte and TypeScript in Vite, building mobile applications or web sites with SQLite
## Recommended IDE Setup
[VS Code](https://code.visualstudio.com/) + [Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).
## 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 + TypeScript + 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 `allowJs` in the TS template?**
While `allowJs: false` would indeed prevent the use of `.js` files in the project, it does not prevent the use of JavaScript syntax in `.svelte` files. In addition, it would force `checkJs: false`, bringing the worst of both worlds: not being able to guarantee the entire codebase is TypeScript, and also having worse typechecking for the existing JavaScript. In addition, there are valid use cases in which a mixed codebase may be relevant.
**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.
```ts
// store.ts
// An extremely simple external store
import { writable } from "svelte/store";
export default writable(0);
```
## Capacitor SQLite Integration
### Install SQLite plugin
```bash
npm install @capacitor-community/sqlite
```
### Install jeep-sqlite for web platform support
```bash
npm install jeep-sqlite
```
### Copy WASM files
```bash
mkdir -p public/assets
cp node_modules/sql.js/dist/sql-wasm.wasm public/assets/
```
### Install Capacitor
```bash
npm install @capacitor/core @capacitor/cli
npm install @capacitor/app @capacitor/core @capacitor/haptics @capacitor/keyboard @capacitor/status-bar
npx capacitor init "svelte-sqlite-capacitor" "svelte.sqlite.capacitor" --web-dir dist
```
### Add platforms, optionally
```bash
npx cap add android
npx cap add ios
```
### IOS extra steps:
Add to `ios/App/App/Info.plist`:
```xml
UIFileSharingEnabled
LSSupportsOpeningDocumentsInPlace
```
### Android extra steps:
Add to `android/app/src/main/AndroidManifest.xml`:
```xml
```
- [Capacitor](https://capacitorjs.com/)