We are under construction…

Progressive Web Apps HQ

Progressive Web Apps HQ summarizes the set of features that Progressive Web Apps exhibit on modern platforms at the same time it enumerates the technologies supporting these features while keeping a list of resources to ease the development and growth of Progressive Web Applications.

This is not a discussion site, nor a proposal hub but a meeting point for those developing Progressive Web Applications with up-to-date and accurate information reflecting the state of the art.

How to contribute?

Progressive Web Apps is a collaborative Jekyll 3 web site using collections. You can contribute by adding new items to collections or modifying existing information. In any case, simply send a pull request.

Building the site

You want to contribute and you want the HQ running on localhost. You will need Jekyll 3 which needs Ruby v2.x to work.

The safest and most compatible way to install Ruby is by using rbenv. Visit the link to find the proper way to install it according to your operating system.

# list all installable versions
$ rbenv install -l

# install the last stable version
$ rbenv install 2.3.0

Now you can install Jekyll 3 as a gem:

$ gem install jekyll

And run:

$ jekyll serve

Resources

The easiest way of contributing is by adding a resource. If your resource is about one feature, add a resource entry to the feature document inside the _features folder. If it is related with a technology, do the same with the proper entry inside _technologies folder. The format of a resource entry is as follows:

• type: currently one of doc, demo or tool. Documentation and tutorials should be tagged doc; live demoes / examples should be categorized demo and framework or libraries should be considered of type tool.
• name: the name of the resource.
• url: its URL.
• description: a brief description of the resource.

Features

Features is one of the HQ collections. They are characteristics of progressive web applications with specific use cases. Currently most of them are motivated by existing native applications use cases. If you want to add a new feature, be sure you have use cases supporting it and technologies that allow it to be implement. In other words, please don't use the collection to propose new features.

The format of a feature is as follows:

• content: is the long explanation for the feature.
• title: is the name of the feature.
• slug: is the id-friendly name for the feature. It's used as the CSS class for the icon.
• description: is the short description shown at index.html.
• usecases: is the list of use cases.
• technologies: is the list of technologies used to realize the feature. Use the slug representation when listing technologies.
• resources: list of resources related with the feature.

Technologies

Technologies is the other of the HQ main collections. They are the set of APIs, protocols, standards and techniques implementing features. This is not the place for ellaborated documentation, if you have published a tutorial or a blog post about a technology, it is a resource related with that technology. If you feel some technology is missed, add a new item to the collection but be sure your technology supports at least one feature.

The metadata for technologies includes:

• content: is the long explanation for the technology.
• title: is the name of the technology.
• slug: is the id-friendly name for the technology. It's used inside features front matter to set the relationship between features and technologies.
• description: is the short description shown at index.html.
• status: is the URL for the specific platform status section for the technology.
• spec: is the URL for the official specification of that technology.
• resources: list of resources related with the feature.

Is the HQ a Progressive App?

Currently, Progressive Web Apps HQ is using jekyll-offline plug-in to add offline support but we are working on other aspects of progressive web applications. Which aspects? Visit the HQ!