[16.0][MIG] - shopfloor_mobile_base

.pre-commit-config.yaml

@@ -88,6 +88,8 @@ repos:
     rev: v8.24.0
     hooks:
       - id: eslint
+        # Useless for external libs
+        exclude: ^shopfloor_mobile_base/static/wms/src/.*
         verbose: true
         args:
           - --color

setup/shopfloor_mobile_base/odoo/addons/shopfloor_mobile_base

@@ -0,0 +1 @@
+../../../../shopfloor_mobile_base

setup/shopfloor_mobile_base/setup.py

@@ -0,0 +1,6 @@
+import setuptools
+
+setuptools.setup(
+    setup_requires=['setuptools-odoo'],
+    odoo_addon=True,
+)

shopfloor_mobile_base/README.rst

@@ -0,0 +1,238 @@
+================
+Shopfloor mobile
+================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! 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%2Fwms-lightgray.png?logo=github
+    :target: https://github.com/OCA/wms/tree/14.0/shopfloor_mobile_base
+    :alt: OCA/wms
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/wms-14-0/wms-14-0-shopfloor_mobile_base
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/285/14.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+Base frontend for Shopfloor applications.
+
+The work is organized in scenario.
+A scenario represents a process in the workplace (eg: for WMS -> receive, deliver).
+The app allows to start each process through the main menu.
+
+Each scenario is linked to a specific menu item which can be configured in the backend.
+Each scenario drives you through the work to do.
+
+
+Tech details
+~~~~~~~~~~~~
+
+* This frontend is built on top of `VueJS <vuejs.org>`_  and `VuetifyJS <vuetifyjs.com/>`_
+  and relies on `shopfloor` module that exposes REST API in Odoo
+  (based in turn on `base_rest <https://github.com/OCA/rest-framework/tree/13.0/base_rest>`_).
+
+* The whole business logic comes from `shopfloor_base` module,
+  this module takes care of providing a nice and reactive UI to work with.
+
+* No Odoo JS is used, no assets machinery used.
+
+  Static assets are loaded straight, served by a specific controller.
+  This app is a Single Page App, hence resources are loaded only once.
+
+  The version of the module appended to the URL of each resources
+  makes sure it's not cached when the version changes.
+
+* When developing you can use a demo mode which allows to define interactive scenario
+  with pure JS demo data, without interacting with Odoo.
+  Nothing to deal with Odoo demo data.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+Pre-requisites
+~~~~~~~~~~~~~~
+
+* Your Odoo instance is accessible via mobile device
+* You have an API Key configured
+
+Start the app
+~~~~~~~~~~~~~
+
+* Go to "Inventory -> Configuration -> Shopfloor -> Shopfloor App"
+* In the login screen fill in your API key
+* Hit "Login"
+
+Select a profile
+~~~~~~~~~~~~~~~~
+
+Several profiles can be configured in the backend,
+you must choose one before starting.
+
+* Tap on "Configure profile"
+* Select a profile
+
+This will load all available menu items for the selected profile.
+
+Change language
+~~~~~~~~~~~~~~~
+
+* Go to "Settings -> Language"
+* Select a language
+
+Customization
+~~~~~~~~~~~~~
+
+Please refer to `shopfloor_mobile_custom_example`.
+
+
+Working environment
+~~~~~~~~~~~~~~~~~~~
+
+You can control which running env is considerd by Odoo config or env vars.
+
+
+For Odoo config: `running_env` or `shopfloor_running_env`.
+
+For env var: `RUNNING_ENV` or `SHOPFLOOR_RUNNING_ENV`.
+
+Expected key `RUNNING_ENV` is compliant w/ `server_environment` naming but is not depending on it.
+
+Additionally, as specific key for Shopfloor is supported.
+
+**You don't need `server_environment` module to use this feature.**
+
+Known issues / Roadmap
+======================
+
+* Split module by scenario
+* Improve documentation and demo data
+* Document each component
+* Document demo mode
+* Find / create a nice icon
+* Finish base translations (move all UI strings to translatable terms)
+* Use SCSS
+* Refactor states definition
+
+  States are now part of the scenario data. They should be specific objects with their own class.
+  They should also provide all the actions that should be displayed w/ their handlers when needed.
+  Actions can be popup actions or buttons at the bottom of the screen.
+  The tricky part here could be how to register this states for the given component.
+  Today states have access to the full object of the scenario component as they are part of it.
+  `_get_state_spec` could probably lookup for registered states
+  (eg: when you register a component in the registry you should provide states as well).
+  When we'll have states in this fashion we should also consider if they should provide their own template.
+  This way the component template will hold only the generic bits of the scenario.
+
+* Back buttons should be smarter
+
+  In some cases getting back using history is fine but very often this could lead to outdated data display.
+  To mitigate this in particular scenario's steps, custom handlers for the back action have been implemented.
+  For instance, in cluster_picking when you hit back on manual selection it forces the state to go to start and reload.
+  For starting we should provide `on_back` property to all states where we want to display it
+  (no more specific check on the state to display this button).
+  This part is also related to "Refactor states definition".
+
+* Load modules/components dependencies
+
+  As of today we are using bare ES6 imports which requires devs to know the exact path
+  of the resource. If the resource changes name or path dependent files will be broken.
+  It would be nice to have a way to declare modules by name as Odoo JS does.
+
+* Get rid of custom assets controller?
+
+  A controller takes care of loading static assets but seems to not be needed anymore.
+
+Changelog
+=========
+
+13.0.1.0.0
+~~~~~~~~~~
+
+First official version.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/wms/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/wms/issues/new?body=module:%20shopfloor_mobile_base%0Aversion:%2014.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
+~~~~~~~
+
+* Camptocamp
+* BCIM
+* Akretion
+
+Contributors
+~~~~~~~~~~~~
+
+* Simone Orsi <[email protected]>
+* Thierry Ducrest <[email protected]>
+* Guewen Baconnier <[email protected]>
+* Juan Miguel Sánchez Arce  <[email protected]>
+* Raphaël Reverdy <[email protected]>
+* Sébastien Beau <[email protected]>
+* Jacques-Etienne Baudoux <[email protected]>
+
+Design
+~~~~~~
+
+* Joël Grand-Guillaume <[email protected]>
+* Jacques-Etienne Baudoux <[email protected]>
+
+Other credits
+~~~~~~~~~~~~~
+
+**Financial support**
+
+* Cosanum
+* Camptocamp R&D
+* Akretion R&D
+
+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-simahawk| image:: https://github.com/simahawk.png?size=40px
+    :target: https://github.com/simahawk
+    :alt: simahawk
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-simahawk| 
+
+This module is part of the `OCA/wms <https://github.com/OCA/wms/tree/14.0/shopfloor_mobile_base>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

shopfloor_mobile_base/__init__.py

@@ -0,0 +1 @@
+from . import controllers

shopfloor_mobile_base/__manifest__.py

@@ -0,0 +1,18 @@
+# Copyright 2020 Camptocamp SA (http://www.camptocamp.com)
+# Copyright 2020 BCIM (http://www.bcim.be)
+# Copyright 2020 Akretion (http://www.akretion.com)
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+{
+    "name": "Shopfloor mobile",
+    "summary": "Mobile frontend for WMS Shopfloor app",
+    "version": "16.0.1.0.0",
+    "development_status": "Beta",
+    "depends": ["shopfloor_base"],
+    "author": "Camptocamp, BCIM, Akretion, Odoo Community Association (OCA)",
+    "maintainers": ["simahawk"],
+    "website": "https://github.com/OCA/wms",
+    "category": "Warehouse Management",
+    "license": "LGPL-3",
+    "installable": True,
+    "data": ["templates/main.xml", "templates/assets.xml", "views/shopfloor_app.xml"],
+}

shopfloor_mobile_base/controllers/__init__.py

@@ -0,0 +1 @@
+from . import main