Author: |
La Louve, Druidoo |
License: |
AGPL-3 |
Branch: |
20220905_pre |
Repository: |
trobz/odoo-production |
Dependencies: |
base,
coop_membership,
and
coop_shift |
Languages: |
CSS (6122, 18.4%),
HTML (614, 1.8%),
JavaScript (25763, 77.4%),
PO File (127, 0.4%),
Python (258, 0.8%),
XML (270, 0.8%),
and
reStructuredText (112, 0.3%) |
Other branches: |
12.0,
12.0_dev,
12.0_migrate_shift_operations,
20180112,
20180119,
20180126,
20180202,
20180209,
20180302,
20180309,
20180323,
20180330,
20180406,
20180413,
20180420,
20180504,
20180511,
20180518,
20180525,
20180601,
20180608,
20180615,
20180622,
20180629,
20180706,
20180713,
20180720,
20180727,
20180727-1,
20180803,
20180810,
20180817,
20180824,
20180831,
20180907,
20180914,
20180921,
20180928,
9.0,
9.0-fix-reconcile,
9.0-memberspace-20180921,
9.0-template-recurrence,
9.0_S#210419,
9.0_bk,
9.0_deployment,
9.0_yassine,
F#23633,
F#23811,
F#25715,
F#25720_3,
F#25759,
F#25759_1,
F#25770_2,
F#25812,
F#26146_1,
F#26729_2,
F#26743,
F#27571_IMP,
F#27960,
F#27961,
F#27961_1,
F#29078,
F#29400,
F#29760_newest,
and
F#30036 |
Other repositories: |
AwesomeFoodCoops/odoo-production,
DITIntl/odoo-production,
Groupe-Informatique-LaCoopSurMer/odoo-production,
Otsokop/odoo-production,
azmeuk/odoo-production,
chetanrdhaduk/odoo-production,
criptomart/odoo-production,
demain-supermarche/odoo-production,
dlemireanybox/odoo-foodcoops,
druidoo/FoodCoops,
dzungtran89/odoo-production,
estevebadia/odoo-production,
fjouatte/odoo-production,
hilarak/odoo-production,
krunal267/odoo-production,
lachouettecoop/odoo-production,
mathieuvatel/odoo-production,
mszinte/odoo-production,
mulaudzicalvin/odoo-production,
nthnnl/odoo-production,
odoo-modules/odoo-production,
petrus-v/odoo-foodcoops,
phuctranerp/odoo-production,
rihene-abdelwahed/odoo-production,
sc4you/odoo-production,
siddharth7815/odoo-production,
suningwz/odoo-production,
supercoopbdx/odoo-production,
vidtsin/odoo-production,
and
yuntux/odoo-production |
<h1 class="title">Coop Badge Reader</h1>
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/druidoo/FoodCoops/tree/12.0/coop_badge_reader"><img alt="druidoo/FoodCoops" src="https://img.shields.io/badge/github-druidoo%2FFoodCoops-lightgray.png?logo=github" /></a></p>
<p>Provide light JS apps that provides badge reader interface.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id1">Usage</a></h2>
<p>Once installed, the apps is available via this url
<a class="reference external" href="http://localhost:8069/coop_badge_reader/static/www/index.html">http://localhost:8069/coop_badge_reader/static/www/index.html</a> (by default)</p>
<p>You can prefill identification data on the form, using parameters
<a class="reference external" href="http://localhost:8069/coop_badge_reader/static/www/index.html#/login">http://localhost:8069/coop_badge_reader/static/www/index.html#/login</a>?db=DATABASE&username=USERNAME&password=PASSWORD</p>
<p>If all parameters are provided, auto submit is done, to try identification.</p>
<p>Note : set password in an url can generate security breaches.</p>
<p># Authentication</p>
<p>User must select Database name, login and password. (The user must be
member of the new group 'Coop Badge Reader / Time Clock')</p>
<img alt="https://raw.githubusercontent.com/druidoo/FoodCoops/12.0/coop_badge_reader/static/description/authentication.png" src="https://raw.githubusercontent.com/druidoo/FoodCoops/12.0/coop_badge_reader/static/description/authentication.png" />
<p># User Search</p>
<p>User should scan User barcode.</p>
<img alt="https://raw.githubusercontent.com/druidoo/FoodCoops/12.0/coop_badge_reader/static/description/user_search.png" src="https://raw.githubusercontent.com/druidoo/FoodCoops/12.0/coop_badge_reader/static/description/user_search.png" />
<p>If the barcode is unknown a specific sound is played.</p>
<img alt="https://raw.githubusercontent.com/druidoo/FoodCoops/12.0/coop_badge_reader/static/description/user_not_found.png" src="https://raw.githubusercontent.com/druidoo/FoodCoops/12.0/coop_badge_reader/static/description/user_not_found.png" />
<p># Partner Form</p>
<p>If the barcode matches with a user, the partner is display with some
informations.</p>
<img alt="https://raw.githubusercontent.com/druidoo/FoodCoops/12.0/coop_badge_reader/static/description/partner_success.png" src="https://raw.githubusercontent.com/druidoo/FoodCoops/12.0/coop_badge_reader/static/description/partner_success.png" />
<p>If the partner has some special state, an alternative background color is
displayed with the reason.</p>
<img alt="https://raw.githubusercontent.com/druidoo/FoodCoops/12.0/coop_badge_reader/static/description/partner_warning.png" src="https://raw.githubusercontent.com/druidoo/FoodCoops/12.0/coop_badge_reader/static/description/partner_warning.png" />
<p># Move Logs</p>
<p>The use of this badge reader is logged and and logs are available in
back-office</p>
<img alt="https://raw.githubusercontent.com/druidoo/FoodCoops/12.0/coop_badge_reader/static/description/user_moves.png" src="https://raw.githubusercontent.com/druidoo/FoodCoops/12.0/coop_badge_reader/static/description/user_moves.png" />
<p># Technical Information - Back office</p>
<ul class="simple">
<li>Create a new group 'Coop Badge Reader / User' User must be member
of that group to access to the history of the logs;</li>
<li>Create a new group 'Coop Badge Reader / Time Clock' User must be member
of that group to log into the JS apps;</li>
<li>Create a new group 'Coop Badge Reader / Manager' User must be member
of that group to manage (update or delete) logs in backoffice;</li>
</ul>
<p># Technical Information - JS Apps</p>
<p>The extra libs used are</p>
<ul class="simple">
<li>Bootstrap - v3.3.6 <<a class="reference external" href="http://getbootstrap.com">http://getbootstrap.com</a>></li>
<li>AngularJS - v1.3.15 <<a class="reference external" href="http://angularjs.org">http://angularjs.org</a>></li>
<li>IonicJS - v1.0.0 <<a class="reference external" href="http://ionicframework.com/">http://ionicframework.com/</a>></li>
<li>Angular Odoo <<a class="reference external" href="https://github.com/akretion/angular-odoo">https://github.com/akretion/angular-odoo</a>>, little JS framework
based on angular, that provides functions to connect and communicate with
Odoo / OCB</li>
</ul>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h2>
<ul class="simple">
<li>display partner with bootstrap colors in kanban and tree view</li>
<li>The JS apps is not translatable for the time being and is available only
in french</li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id3">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/druidoo/FoodCoops/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/druidoo/FoodCoops/issues/new?body=module:%20coop_badge_reader%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id4">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id5">Authors</a></h3>
<ul class="simple">
<li>La Louve</li>
<li>Druidoo</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id6">Contributors</a></h3>
<ul class="simple">
<li>Sylvain LE GAL <<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>></li>
<li>Druidoo (<<a class="reference external" href="https://www.druidoo.io">https://www.druidoo.io</a>>)</li>
</ul>
<p>Icon module comes from <<a class="reference external" href="https://www.iconfinder.com/icons/52644/card_reader_security_icon">https://www.iconfinder.com/icons/52644/card_reader_security_icon</a>> and is copyright by <www.tpdkdesign.net></p>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id7">Maintainers</a></h3>
<p>This module is part of the <a class="reference external" href="https://github.com/druidoo/FoodCoops/tree/12.0/coop_badge_reader">druidoo/FoodCoops</a> project on GitHub.</p>
<p>You are welcome to contribute.</p>