From 35fcb45e9a6363328e6fe4a8f598bcfdb7443b12 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Tue, 2 Jun 2020 08:07:22 +0000 Subject: [PATCH] [UPD] README.rst --- web_pwa/README.rst | 127 +++++++ web_pwa/static/description/index.html | 465 ++++++++++++++++++++++++++ 2 files changed, 592 insertions(+) create mode 100644 web_pwa/README.rst create mode 100644 web_pwa/static/description/index.html diff --git a/web_pwa/README.rst b/web_pwa/README.rst new file mode 100644 index 000000000..29bf53cd5 --- /dev/null +++ b/web_pwa/README.rst @@ -0,0 +1,127 @@ +=========================== +Progressive web application +=========================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github + :target: https://github.com/OCA/web/tree/12.0/web_pwa + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-12-0/web-12-0-web_pwa + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/162/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +Make Odoo an installable Progressive Web Application. + +Progressive Web Apps provide an installable, app-like experience on desktop and mobile that are built and delivered directly via the web. +They're web apps that are fast and reliable. And most importantly, they're web apps that work in any browser. +If you're building a web app today, you're already on the path towards building a Progressive Web App. + +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +After having installed this module, browsing your odoo on mobile you will be able to install it as a PWA. + +It is strongly recommended to use this module with a responsive layout, like the one provided by web_responsive. + +This module is intended to be used by Odoo back-end users (employees). + +When a Progressive Web App is installed, it looks and behaves like all of the other installed apps. +It launches from the same place that other apps launch. It runs in an app without an address bar or other browser UI. +And like all other installed apps, it's a top level app in the task switcher. + +In Chrome, a Progressive Web App can either be installed through the three-dot context menu. + +This module also provides a "Install PWA" link in Odoo user menu. + +Configuration +============= + +The following system parameters con be set to customize the appearance of the application + +* pwa.manifest.name (defaults to "Odoo PWA") +* pwa.manifest.short_name (defaults to "Odoo PWA") +* pwa.manifest.icon128x128 (defaults to "/web_pwa/static/img/icons/icon-128x128.png") +* pwa.manifest.icon144x144 (defaults to "/web_pwa/static/img/icons/icon-144x144.png") +* pwa.manifest.icon152x152 (defaults to "/web_pwa/static/img/icons/icon-152x152.png") +* pwa.manifest.icon192x192 (defaults to "/web_pwa/static/img/icons/icon-192x192.png") +* pwa.manifest.icon256x256 (defaults to "/web_pwa/static/img/icons/icon-256x256.png") +* pwa.manifest.icon512x512 (defaults to "/web_pwa/static/img/icons/icon-512x512.png") + +Known issues / Roadmap +====================== + +* Evaluate to extend ``FILES_TO_CACHE`` +* Evaluate to use a normal JS file for service worker and download data from a normal JSON controller +* Integrate `Notification API `_ +* Integrate `Web Share API `_ +* Create ``portal_pwa`` module, intended to be used by front-end users (customers, suppliers...) + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* TAKOBI + +Contributors +~~~~~~~~~~~~ + +* `TAKOBI `_: + + * Lorenzo Battistini + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +.. |maintainer-eLBati| image:: https://github.com/eLBati.png?size=40px + :target: https://github.com/eLBati + :alt: eLBati + +Current `maintainer `__: + +|maintainer-eLBati| + +This module is part of the `OCA/web `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/web_pwa/static/description/index.html b/web_pwa/static/description/index.html new file mode 100644 index 000000000..f475e3ae2 --- /dev/null +++ b/web_pwa/static/description/index.html @@ -0,0 +1,465 @@ + + + + + + +Progressive web application + + + +
+

Progressive web application

+ + +

Beta License: LGPL-3 OCA/web Translate me on Weblate Try me on Runbot

+

Make Odoo an installable Progressive Web Application.

+

Progressive Web Apps provide an installable, app-like experience on desktop and mobile that are built and delivered directly via the web. +They’re web apps that are fast and reliable. And most importantly, they’re web apps that work in any browser. +If you’re building a web app today, you’re already on the path towards building a Progressive Web App.

+

Table of contents

+ +
+

Installation

+

After having installed this module, browsing your odoo on mobile you will be able to install it as a PWA.

+

It is strongly recommended to use this module with a responsive layout, like the one provided by web_responsive.

+

This module is intended to be used by Odoo back-end users (employees).

+

When a Progressive Web App is installed, it looks and behaves like all of the other installed apps. +It launches from the same place that other apps launch. It runs in an app without an address bar or other browser UI. +And like all other installed apps, it’s a top level app in the task switcher.

+

In Chrome, a Progressive Web App can either be installed through the three-dot context menu.

+

This module also provides a “Install PWA” link in Odoo user menu.

+
+
+

Configuration

+

The following system parameters con be set to customize the appearance of the application

+
    +
  • pwa.manifest.name (defaults to “Odoo PWA”)
    • +
  • pwa.manifest.short_name (defaults to “Odoo PWA”)
    • +
  • pwa.manifest.icon128x128 (defaults to “/web_pwa/static/img/icons/icon-128x128.png”)
    • +
  • pwa.manifest.icon144x144 (defaults to “/web_pwa/static/img/icons/icon-144x144.png”)
    • +
  • pwa.manifest.icon152x152 (defaults to “/web_pwa/static/img/icons/icon-152x152.png”)
    • +
  • pwa.manifest.icon192x192 (defaults to “/web_pwa/static/img/icons/icon-192x192.png”)
    • +
  • pwa.manifest.icon256x256 (defaults to “/web_pwa/static/img/icons/icon-256x256.png”)
    • +
  • pwa.manifest.icon512x512 (defaults to “/web_pwa/static/img/icons/icon-512x512.png”)
    • +
+
+
+

Known issues / Roadmap

+
    +
  • Evaluate to extend FILES_TO_CACHE
    • +
  • Evaluate to use a normal JS file for service worker and download data from a normal JSON controller
    • +
  • Integrate Notification API
    • +
  • Integrate Web Share API
    • +
  • Create portal_pwa module, intended to be used by front-end users (customers, suppliers…)
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • TAKOBI
    • +
+
+
+

Contributors

+
    +
  • TAKOBI:
      +
    • Lorenzo Battistini
      • +
    +
    • +
+
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

Current maintainer:

+

eLBati

+

This module is part of the OCA/web project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ +