mirror of https://github.com/OCA/web.git
128 lines
5.0 KiB
ReStructuredText
128 lines
5.0 KiB
ReStructuredText
===========================
|
|
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/13.0/web_pwa_oca
|
|
:alt: OCA/web
|
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
|
:target: https://translation.odoo-community.org/projects/web-13-0/web-13-0-web_pwa_oca
|
|
: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/13.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_oca/static/img/icons/icon-128x128.png")
|
|
* pwa.manifest.icon144x144 (defaults to "/web_pwa_oca/static/img/icons/icon-144x144.png")
|
|
* pwa.manifest.icon152x152 (defaults to "/web_pwa_oca/static/img/icons/icon-152x152.png")
|
|
* pwa.manifest.icon192x192 (defaults to "/web_pwa_oca/static/img/icons/icon-192x192.png")
|
|
* pwa.manifest.icon256x256 (defaults to "/web_pwa_oca/static/img/icons/icon-256x256.png")
|
|
* pwa.manifest.icon512x512 (defaults to "/web_pwa_oca/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 <https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification>`_
|
|
* Integrate `Web Share API <https://web.dev/web-share/>`_
|
|
* Create ``portal_pwa`` module, intended to be used by front-end users (customers, suppliers...)
|
|
|
|
Bug Tracker
|
|
===========
|
|
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/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 <https://github.com/OCA/web/issues/new?body=module:%20web_pwa_oca%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
|
|
|
Do not contact contributors directly about support or help with technical issues.
|
|
|
|
Credits
|
|
=======
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
* TAKOBI
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* `TAKOBI <https://takobi.online>`_:
|
|
|
|
* 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 <https://odoo-community.org/page/maintainer-role>`__:
|
|
|
|
|maintainer-eLBati|
|
|
|
|
This module is part of the `OCA/web <https://github.com/OCA/web/tree/13.0/web_pwa_oca>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|