================
Shopfloor mobile
================

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
    :target: https://odoo-community.org/page/development-status
    :alt: Alpha
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fwms-lightgray.png?logo=github
    :target: https://github.com/OCA/wms/tree/13.0/shopfloor_mobile
    :alt: OCA/wms
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/wms-13-0/wms-13-0-shopfloor_mobile
    :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/13.0
    :alt: Try me on Runbot

|badge1| |badge2| |badge3| |badge4| |badge5| 

Frontend for Shopfloor app.

The work is organized in scenario.
A scenario represents a process in the warehouse (eg: 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` 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.

.. IMPORTANT::
   This is an alpha version, the data model and design can change at any time without warning.
   Only for development or testing purpose, do not use in production.
   `More details on development status <https://odoo-community.org/page/development-status>`_

**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`.

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

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%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
~~~~~~~

* Camptocamp
* BCIM
* Akretion

Contributors
~~~~~~~~~~~~

* Simone Orsi <simahawk@gmail.com>
* Thierry Ducrest <thierry.ducrest@camptocamp.com>
* Guewen Baconnier <guewen.baconnier@camptocamp.com>
* Raphaël Reverdy <raphael.reverdy@akretion.com>
* Sébastien Beau <sebastien.beau@akretion.com>

Design
~~~~~~

* Joël Grand-Guillaume <joel.grandguillaume@camptocamp.com>
* Jacques-Etienne Baudoux <je@bcim.be>

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/13.0/shopfloor_mobile>`_ project on GitHub.

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