Author: |
Compassion CH |
License: |
AGPL-3 |
Branch: |
CO-3443 |
Repository: |
nfluckiger/compassion-modules |
Dependencies: |
sale_management |
Languages: |
Python (276, 65.2%),
and
XML (147, 34.8%) |
Other branches: |
12.0,
AP-354,
AP-364,
CO-2586,
CO-2601,
CO-2631,
CO-2643,
CO-2658,
CO-2667,
CO-2668,
CO-3186,
CO-3256,
CO-3414,
CO-3444,
CO-3449,
and
devel |
Other repositories: |
Alaggaerion/compassion-modules,
CompassionCH/compassion-modules,
Grazia976/compassion-modules,
Nooka10/compassion-modules,
Quillasp/compassion-modules,
SylvainLosey/compassion-modules,
Theyiot/compassion-modules,
davidwul/compassion-accounting,
davidwul/compassion-modules,
ecino/compassion-modules,
eicher31/compassion-modules,
joblo-compassion/compassion-modules,
jonathantarabbia/compassion-modules,
josueBulle/compassion-modules,
nbornand/compassion-modules,
quentingigon/compassion-modules,
samybucher/compassion-modules,
simhayoz/compassion-modules,
suningwz/compassion-modules,
vwvw/compassion-modules,
and
wvmrtn/compassion-modules |
<h1 class="title">Compassion EU Firebase Connector</h1>
<p><a class="reference external" 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" 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" href="https://github.com/CompassionCH/compassion-modules/tree/AP-73/firebase_connector"><img alt="CompassionCH/compassion-modules" src="https://img.shields.io/badge/github-CompassionCH%2Fcompassion--modules-lightgray.png?logo=github" /></a></p>
<p>This module adds the ability to send notifications from Odoo to devices that have subscribed via Firebase Cloud Messaging.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id2">Configuration</a></li>
<li><a class="reference internal" href="#usage" id="id3">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id4">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#changelog" id="id5">Changelog</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id6">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id7">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id8">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id9">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id10">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id2">Configuration</a></h2>
<p>Make sure the following variable is defined in your odoo.conf file:</p>
<ul class="simple">
<li><cite>google_application_credentials</cite>: Path to your json file containing the Firebase adminsdk keys</li>
</ul>
<p>You can generate a new private key file in the Firebase console -> Settings -> Generate new Private Key</p>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id3">Usage</a></h2>
<p>This module lets you send notifications and data message via Firebase to mobile devices.</p>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id4">Known issues / Roadmap</a></h2>
<ul class="simple">
<li>Provide mass messaging</li>
</ul>
<a name="changelog"></a>
<h2 class="with-subtitle"><a class="toc-backref" href="#id5">Changelog</a></h2>
<h2 class="section-subtitle" id="id1"><span class="section-subtitle">10.0.0.0.0 (2019-05-15)</span></h2>
<ul class="simple">
<li>[ADD] Add the module</li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id6">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/CompassionCH/compassion-modules/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/CompassionCH/compassion-modules/issues/new?body=module:%20firebase_connector%0Aversion:%20AP-73%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="#id7">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id8">Authors</a></h3>
<ul class="simple">
<li>Compassion CH</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id9">Contributors</a></h3>
<ul class="simple">
<li>Nicolas Badoux <<a class="reference external" href="mailto:n.badoux@hotmail.com">n.badoux@hotmail.com</a>></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id10">Maintainers</a></h3>
<p>This module is maintained by Compassion Switzerland.</p>
<a class="reference external image-reference" href="https://www.compassion.ch"><img alt="Compassion Switzerland" src="https://upload.wikimedia.org/wikipedia/en/8/83/CompassionInternationalLogo.png" /></a>
<p>Compassion Switzerland is a nonprofit organization whose
mission is to release children from extreme poverty in Jesus name.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/CompassionCH/compassion-modules/tree/AP-73/firebase_connector">CompassionCH/compassion-modules</a> project on GitHub.</p>