https://github.com/jesusgraterol/sw-builder
The sw-builder package automates the creation of your Application's Service Worker, which pre-caches your build. This leads to a better overall performance and enables users to access your PWA without an Internet connection.
https://github.com/jesusgraterol/sw-builder
api app cache gui interface progressive progressive-web-application pwa service-worker sw user-interface web web-api
Last synced: about 2 months ago
JSON representation
The sw-builder package automates the creation of your Application's Service Worker, which pre-caches your build. This leads to a better overall performance and enables users to access your PWA without an Internet connection.
- Host: GitHub
- URL: https://github.com/jesusgraterol/sw-builder
- Owner: jesusgraterol
- License: mit
- Created: 2024-05-11T14:24:41.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-28T19:44:34.000Z (12 months ago)
- Last Synced: 2024-07-06T09:59:03.991Z (10 months ago)
- Topics: api, app, cache, gui, interface, progressive, progressive-web-application, pwa, service-worker, sw, user-interface, web, web-api
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/sw-builder
- Size: 214 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Service Worker Builder
The `sw-builder` package automates the creation of your Application's Service Worker, which pre-caches your build. This leads to a better overall performance and enables users to access your PWA without an Internet connection.
## Getting Started
Install the package:
```bash
npm install -D sw-builder
```
Create the `sw-builder.config.json` file in your project's root:
```json
{
"outDir": "dist",
"template": "base",
"includeToPrecache": [
"/assets",
"/some-other-dir",
"/index.html",
"/logo.png",
"/splash.png"
],
"excludeFilesFromPrecache": [
"some-ignorable-file.woff2"
],
"excludeMIMETypesFromCache": [
"application/json",
"text/plain"
]
}
```
Include the `sw-builder` binary in your `package.json` file:
```json
...
"scripts": {
"build": "tsc -b && vite build && sw-builder",
// specify a custom path for the configuration file
"build": "tsc -b && vite build && sw-builder --config='sw-custom.config.json'",
}
...
```
If you are using [Vite](https://vitejs.dev/) include an empty `sw.js` file in your `public` directory so you can test the Service Worker's Registration while developing.
## Types
IBaseConfig
The configuration required to build the 'base' template. This type should be turned into a discriminated union once more templates are introduced.
```typescript
type IBaseConfig = {
// the dir path in which the build's output is placed
outDir: string;
// the name of the template that will be generated
template: ITemplateName;
// the list of asset paths that will be traversed and included in the cache
includeToPrecache: string[];
// the list of file names that will be ignored
excludeFilesFromPrecache: string[];
// the list of MIME Types that won't be cached when the app sends HTTP GET requests
excludeMIMETypesFromCache: string[];
};
```
## Templates
- [`base`](https://github.com/jesusgraterol/sw-builder/blob/main/src/template/templates/base-template.sw.js)
## Built With
- TypeScript
## Tests
```bash
# unit tests
npm run test:unit
# integration tests
npm run test:integration
```
## License
[MIT](https://choosealicense.com/licenses/mit/)
## Deployment
Install dependencies:
```bash
npm install
```
Build the project:
```bash
npm start
```
Publish to `npm`:
```bash
npm publish
```