Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tretapey/svelte-pwa
Svelte Progresssive Web App (PWA) starter template
https://github.com/tretapey/svelte-pwa
open-source pwa svelte template
Last synced: 3 months ago
JSON representation
Svelte Progresssive Web App (PWA) starter template
- Host: GitHub
- URL: https://github.com/tretapey/svelte-pwa
- Owner: tretapey
- Created: 2020-05-13T14:23:04.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T15:20:38.000Z (5 months ago)
- Last Synced: 2024-06-20T05:49:10.395Z (5 months ago)
- Topics: open-source, pwa, svelte, template
- Language: JavaScript
- Homepage:
- Size: 207 KB
- Stars: 220
- Watchers: 7
- Forks: 26
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-svelte - svelte-pwa-template - A starter template for PWAs based in the official Template. _(pre-v5)_ (Scaffold / Miscellaneous)
README
---
# Svelte PWA
This is a Progressive Web App (PWA) template for [Svelte](https://svelte.dev) apps. It lives at https://github.com/tretapey/svelte-pwa.
To create a new project based on this template using [degit](https://github.com/Rich-Harris/degit):
```bash
npx degit tretapey/svelte-pwa my-svelte-pwa
cd my-svelte-pwa
```
_Note that you will need to have [Node.js](https://nodejs.org) installed._
## Get started
Install the dependencies...
```bash
cd my-svelte-pwa
npm install
```
...then start [Rollup](https://rollupjs.org):
```bash
npm run dev
```
Navigate to [localhost:5000](http://localhost:5000). You should see your app running. Edit a component file in `src`, save it, and reload the page to see your changes.
By default, the server will only respond to requests from localhost. To allow connections from other computers, edit the `sirv` commands in package.json to include the option `--host 0.0.0.0`.
## PWA Configuration
- The `service-worker.js` and `manifest.json` files are in the `public` folder.
- You should update the icons in `/public/images/icons`
- For an offline experience edit the `/public/offline.html` file.
- This PWA is installable. For more information on how to use check [this repo](https://github.com/pwa-builder/pwa-install).
Note: If you don't want to make the app installable you can remove the script from the `index.html` file in the `public` folder.
For more info, this template was made following this [tutorial](https://codelabs.developers.google.com/codelabs/your-first-pwapp)
## Building and running in production mode
To create an optimised version of the app:
```bash
npm run build
```