Convert Figma logo to code with AI

TalAter logoUpUp

✈️ Easily create sites that work offline as well as online

4,883
264
4,883
43

Top Related Projects

12,322

📦 Workbox: JavaScript libraries for Progressive Web Apps

Service Workers

The simplest way to create progressive web apps across platforms and devices. Start here. This repo is home to several projects in the PWABuilder family of tools.

💾 Offline storage, improved. Wraps IndexedDB, WebSQL, or localStorage using a simple but powerful API.

Quick Overview

UpUp is a lightweight JavaScript library that allows developers to easily create offline-first web applications. It provides a simple way to define offline content and functionality, ensuring that users can still access your web app even when they lose internet connectivity.

Pros

  • Easy to implement with minimal code
  • Supports offline content and custom offline pages
  • Allows for dynamic content caching
  • Compatible with most modern browsers

Cons

  • Limited advanced features compared to more comprehensive service worker libraries
  • May require additional setup for complex offline scenarios
  • Documentation could be more extensive
  • Not actively maintained (last update was in 2019)

Code Examples

Basic setup to serve an offline page:

UpUp.start({
  'content-url': 'offline.html'
});

Caching multiple resources for offline use:

UpUp.start({
  'content-url': 'offline.html',
  'assets': ['/img/logo.png', '/css/style.css', '/js/app.js']
});

Using a callback function when offline content is displayed:

UpUp.start({
  'content-url': 'offline.html',
  'assets': ['/img/logo.png', '/css/style.css', '/js/app.js'],
  'service-worker-url': '/upup.sw.min.js',
  'on-offline-ready': function() {
    console.log('The offline content is ready');
  }
});

Getting Started

  1. Include the UpUp library in your HTML file:
<script src="https://cdnjs.cloudflare.com/ajax/libs/UpUp/1.1.0/upup.min.js"></script>
  1. Initialize UpUp in your JavaScript code:
UpUp.start({
  'content-url': 'offline.html',
  'assets': [
    '/css/style.css',
    '/img/logo.png',
    '/js/app.js'
  ]
});
  1. Create an offline.html file in your project root to serve as the offline page.

  2. Ensure your web server is configured to serve the UpUp service worker file (upup.sw.min.js) from the root of your site.

Competitor Comparisons

12,322

📦 Workbox: JavaScript libraries for Progressive Web Apps

Pros of Workbox

  • More comprehensive and feature-rich, offering a wide range of tools for service worker management
  • Actively maintained by Google, ensuring regular updates and compatibility with modern web standards
  • Extensive documentation and community support

Cons of Workbox

  • Steeper learning curve due to its extensive feature set
  • Larger file size and potentially more complex setup compared to UpUp

Code Comparison

UpUp (simple offline page setup):

upup.start({
  'content-url': 'offline.html'
});

Workbox (similar offline page setup):

workbox.routing.registerRoute(
  ({request}) => request.mode === 'navigate',
  new workbox.strategies.NetworkOnly({
    plugins: [
      new workbox.precaching.PrecacheController().createHandlerBoundToURL('/offline.html')
    ]
  })
);

Summary

Workbox offers a more comprehensive solution for service worker management, with extensive features and ongoing support from Google. However, it may be overkill for simple offline functionality. UpUp provides a simpler, more straightforward approach for basic offline capabilities but lacks the advanced features and ongoing development of Workbox. The choice between the two depends on the complexity of the project and the specific offline requirements.

Service Workers

Pros of ServiceWorker

  • Standardized API supported by major browsers
  • More powerful and flexible for complex offline scenarios
  • Enables advanced features like background sync and push notifications

Cons of ServiceWorker

  • Steeper learning curve and more complex implementation
  • Requires HTTPS for deployment
  • May be overkill for simple offline functionality needs

Code Comparison

ServiceWorker:

self.addEventListener('fetch', function(event) {
  event.respondWith(
    caches.match(event.request).then(function(response) {
      return response || fetch(event.request);
    })
  );
});

UpUp:

UpUp.start({
  'content-url': 'offline.html',
  'assets': ['images/logo.png', 'css/style.css', 'js/app.js']
});

Summary

ServiceWorker offers a more comprehensive solution for offline web applications, providing advanced features and standardization. However, it comes with increased complexity and stricter requirements. UpUp, on the other hand, provides a simpler approach for basic offline functionality, making it easier to implement but with limited capabilities compared to ServiceWorker.

The choice between the two depends on the specific needs of the project, with ServiceWorker being more suitable for complex applications requiring advanced offline features, while UpUp is ideal for simpler use cases where ease of implementation is prioritized.

The simplest way to create progressive web apps across platforms and devices. Start here. This repo is home to several projects in the PWABuilder family of tools.

Pros of PWABuilder

  • More comprehensive PWA development toolkit with features like manifest generation and app packaging
  • Active development with frequent updates and a larger community
  • Cross-platform support for various app stores (Google Play, Microsoft Store, etc.)

Cons of PWABuilder

  • Steeper learning curve due to more complex features and options
  • Requires more setup and configuration compared to UpUp's simplicity
  • May be overkill for simple offline-first web apps

Code Comparison

UpUp (simple offline page setup):

UpUp.start({
  'content-url': 'offline.html',
  'assets': ['images/logo.png', 'css/style.css']
});

PWABuilder (manifest generation):

const { generateManifest } = require('pwabuilder-lib');

const manifest = generateManifest({
  name: 'My PWA',
  short_name: 'PWA',
  start_url: '/'
});

While UpUp focuses on providing a straightforward solution for offline functionality, PWABuilder offers a more comprehensive set of tools for building full-fledged Progressive Web Apps. UpUp is ideal for developers looking to quickly add offline support to their web apps, whereas PWABuilder caters to those seeking a complete PWA development ecosystem with advanced features and cross-platform deployment options.

💾 Offline storage, improved. Wraps IndexedDB, WebSQL, or localStorage using a simple but powerful API.

Pros of localForage

  • Broader storage support: Offers IndexedDB, WebSQL, and localStorage, automatically choosing the best option
  • More robust data handling: Supports storing complex JavaScript objects, not just strings
  • Active development: Regularly updated with new features and bug fixes

Cons of localForage

  • Larger library size: More comprehensive functionality results in a larger footprint
  • Steeper learning curve: More complex API due to its versatility
  • Not focused on offline functionality: Primarily a storage solution, lacking built-in offline features

Code Comparison

localForage:

localforage.setItem('key', { complex: 'object' }).then(function() {
  return localforage.getItem('key');
}).then(function(value) {
  console.log(value.complex);
}).catch(function(err) {
  console.log(err);
});

UpUp:

UpUp.start({
  'content-url': 'offline.html',
  'assets': ['/img/logo.png', '/css/style.css', '/js/app.js']
});

The code comparison highlights the different focus areas of these libraries. localForage emphasizes flexible data storage with support for complex objects, while UpUp concentrates on providing a simple API for offline content caching and serving.

Convert Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

UpUp - Kickstarting the Offline First Revolution

Offline First with UpUp

UpUp is a tiny JavaScript library that makes sure your users can always access your site's content, even when they're on a plane, in an elevator, or 20,000 leagues under the sea.

Mobile-First has become the de-facto standard for building modern sites. But in a world where everyone is mobile, an always-on connection isn't something we can rely on. It's time to start thinking Offline First.

With UpUp you control the content your users see, even when they are offline. And you can do it with just a single JavaScript command.

Demo & Tutorial

The easiest path to understanding is to see UpUp in action and try a quick tutorial.

Hello World

Getting started with UpUp is as easy as adding two JavaScript files to your site, upup.min.js & upup.sw.min.js, and defining the content you want your users to see when they are offline.

For example:

<script src="/upup.min.js"></script>
<script>
UpUp.start({
  'content-url': 'offline.html',
  'assets': ['/img/logo.png', '/css/style.css', 'headlines.json']
});
</script>

Now every time your users return to your site and their connection is down, they will see the contents of offline.html instead of an error.

Check out some live demos and a full tutorial. Once you're up and rolling, you can read the full API Docs.

HTTPS Requirement

UpUp requires a secure connection to your site (this is a requirement of service workers, the technology at the heart of UpUp). So make sure your users visit your site over HTTPS (an SSL certificate is free with Let’s Encrypt or via CloudFlare).

Browser Support

UpUp works in any browser that supports service workers. Currently this means:

  • Chrome 40+
  • Opera 27+
  • Firefox 41+

If your users are using a different or older browser, they will simply be unaffected by UpUp. Nothing will break, and they simply won't notice anything different.

Technical Documentation and API

Docs and full API reference

Author

Tal Ater: @TalAter

License

Licensed under MIT.

NPM DownloadsLast 30 Days