Skip to content
This repository has been archived by the owner on Nov 27, 2018. It is now read-only.

v1

Closed Nov 21, 2015 100% complete

Oghliner v1 is the initial stable release of Oghliner. It provides the following core features:

  • Bootstrap an app with a build script that enables it to be built, offlined, and deployed to GitHub Pages.
  • Offline an app by generating a Service Worker that caches it on the client in compatible browsers.
  • Deploy an app to GitHub Pages by committing its assets …

Oghliner v1 is the initial stable release of Oghliner. It provides the following core features:

  • Bootstrap an app with a build script that enables it to be built, offlined, and deployed to GitHub Pages.
  • Offline an app by generating a Service Worker that caches it on the client in compatible browsers.
  • Deploy an app to GitHub Pages by committing its assets to its gh-pages branch and pushing the commit upstream.
  • Configure Travis to auto-deploy the app to GitHub Pages when a user merges changes into its master branch.

Oghliner v1 is designed to work well with existing app codebases and popular development and build tools. Its bootstrap template may be opinionated (with a particular directory structure and Gulp build script), but its other methods are designed to work with many kinds of apps and can be integrated into both Gulp and Grunt build scripts. And even bootstrap is compatible with apps scaffolded by Yeoman.

Oghliner v1 is designed to support deployment exclusively to GitHub Pages, however. It doesn't support deployment to other web hosting services. And it enables offlining only in browsers that support Service Workers. It doesn't implement offlining using other technologies (like AppCache).

Finally, Oghliner v1 implements the "cache-first" strategy for offlining apps. It doesn't support other strategies for offlining static assets or caching dynamic data. Service Workers can be used to support a variety of caching strategies, and they can do background sync and handle push notifications, all of which is valuable functionality. But Oghliner v1 is focused on the specific use case of offlining an app the first time it loads (and updating it when it changes), which is the closest web app equivalent to the native app installation and update lifecycle.

In addition to its core features, Oghliner v1 includes complete and accurate documentation, sports comprehensive automated test coverage, and observes Node and NPM best practices. It also demonstrates its capabilities through usage by one or more reference applications.

This milestone is closed.

No open issues remain. View closed issues or see open milestones in this repository.