LukePrior / LukePrior/nbn-upgrade-map

Create Service Worker

Open
#308 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
222
Forks
28
Avg merge
1m
Merged PRs (30d)
2

Description

Will allow site to load quicker and work offline with stored data when installed as a PWA.

Caching Strategy:

  • Map tiles (keep for 30 days)
  • historical NBN info (keep indefinitely)
  • main/current NBN info (fetch every time or maybe keep for a few hrs max)
  • JavaScript files and others (30 days?)

https://stackoverflow.com/questions/46036897/best-practices-for-detecting-offline-state-in-a-service-worker
https://developer.chrome.com/docs/workbox/caching-strategies-overview/

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the service worker and the Workbox caching-strategy guidance linked in the issue. Define caching behavior for map tiles, historical NBN information, current NBN information, and JavaScript assets, including the stated retention periods. Done means the site can load faster and operate offline with stored data when installed as a PWA.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend, web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.