Light

kenchris / jakecache Goto Github PK

View Code? Open in Web Editor NEW

87.0 10.0 13.0 121 KB

Declarative manifest-driven app cache top of ServiceWorker

License: Other

JavaScript 99.42% HTML 0.58%

jakecache's Introduction

JakeCache

Declarative manifest-driven app cache built on top of ServiceWorker.

Why?

Building offline-first applications has been the ubiquius dream since the early days of the web. Google started by introducing Google Gears, and later followed the web community by building Application Cache.

Application Cache was a great step forward, but had several fundamental flaws that were made famous by Jake Archibald's epic Application Cache is a Douchebag article and talk. So Jake, Alex Russell and many others, have been busy working on the next generation of application caching API's which today are know as the Service Worker Specification.

Service Worker is great, but if you ever had a look at it's API(s) you realize that they are complicated imperative JavaScript API's. These API's tend to scare many web developers who prefer a nice forgiving declarative approach.

So in order to fix the too complicated Service Worker API, we are super excited to introduce JakeCache. A declarative manifest-driven application cache for web applications implemented on top of ServiceWorker.

Sarcasm may occur in this project

😂

Polyfill

JakeCache serves the additional purpose of being as compatible with the HTML5 Application Cache (aka AppCache) as we could make it and may serve as a polyfill in browsers removing such support.

Patches are welcome!

Installation

npm install jakecache --save

Get started

Create a new JakeCache Manifest, app.manifest and save it in your root together with the jakecache.js file:

CACHE MANIFEST
# 2010-06-18:v2

# Explicitly cached 'master entries'.
CACHE:
/test.html

# Resources that require the user to be online.
NETWORK:
*

Include jakecache.js on your page, maybe via <script src="jakecache.js"></script>
Add <html manifest="app.manifest"> to your HTML.
That's it! Your website is now Jake-enabled!

License

About this project

This is a project by Kenneth Christiansen & Kenneth Auchenberg and a result of too much 🍺 and ☕.

jakecache's People

Contributors

Stargazers

Watchers

Forkers

auchenberg kyleamathews pandrese adenilson ejb amilajack eqsoft coderofsalvation klues sebastianj2 segios brunolafleur olivertitze

jakecache's Issues

Make the swapCache actually work

As the SW can be killed before this call, we might need to store the responses like in an indexedDB, if these can be stored at all. Then remove existing entries and adding the new ones.

What isn't working?

Can you add a section to README which describes what isn't working/isn't compatible with AppCache?

how was this graph made

features.json shows the following in the demo-environment:

which is basically:

question: how was this made? Using the ui or programmatically?

Update jackecache on npm

Thanks for merging my recent pull requests. Could you update the npm release please?

Check for serviceworker support

Safari 10 doesn't support serviceworkers, so line 111 causes the following error:

TypeError: undefined is not an object (evaluating 'navigator.serviceWorker.addEventListener')

Since Safari still supports appcache, can jakecache let that take over as a fallback?

Compile ES6 build

Since Chrome 54 (the latest version at the time of writing) doesn't support some fancy features like import, I suggest bundling a dist version of jakecache transpiled into ES5.

(Ps. I fully intend to tackle these issues myself. Just noting them for future reference.)

Make serviceworker script path relative

On line 86, is there a reason why the path is absolute rather than relative?

navigator.serviceWorker.register('/jakecache-sw.js').then(registration => {

strict mode breaks in browsers

js.php:1 Uncaught SyntaxError: Unexpected strict mode reserved word

`'use strict';`

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.