Author: |
Compassion CH |
License: |
AGPL-3 |
Branch: |
12.0-forward |
Repository: |
ecino/compassion-modules |
Dependencies: |
base_phone,
child_compassion,
cms_form,
cms_form_compassion,
crm_compassion,
payment_ogone,
queue_job,
stock,
website,
and
website_no_index |
Languages: |
CSS (46, 0.8%),
HTML (19, 0.3%),
JSON (41, 0.7%),
JavaScript (1548, 27.7%),
Markdown (1689, 30.2%),
PO File (777, 13.9%),
Python (1223, 21.9%),
and
XML (246, 4.4%) |
Other branches: |
10.0-emanuel,
10.0-gender-mapping,
11.0-settings,
12.0-fixes,
CO-3754,
add-send-mode-automation,
correspondence-fields,
generation-wizard,
mobile-donation,
remove-dependency,
sbc-migration,
and
translate-gmc |
Other repositories: |
Alaggaerion/compassion-modules,
CompassionCH/compassion-modules,
Grazia976/compassion-modules,
Nooka10/compassion-modules,
Quillasp/compassion-modules,
SylvainLosey/compassion-modules,
Theyiot/compassion-modules,
c-meier/compassion-modules,
davidwul/compassion-accounting,
davidwul/compassion-modules,
eicher31/compassion-modules,
joblo-compassion/compassion-modules,
jonathantarabbia/compassion-modules,
josueBulle/compassion-modules,
maxime-beck/compassion-modules,
nbornand/compassion-modules,
nfluckiger/compassion-modules,
quentingigon/compassion-modules,
samuel-fringeli/compassion-modules,
samybucher/compassion-modules,
simhayoz/compassion-modules,
suningwz/compassion-modules,
vidtsin/compassion-modules,
vwvw/compassion-modules,
and
wvmrtn/compassion-modules |
<h1 class="title">Compassion SMS Sponsorships</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/devel/sms_sponsorship"><img alt="CompassionCH/{compassion-modules}" src="https://img.shields.io/badge/github-CompassionCH%2F{compassion--modules}-lightgray.png?logo=github" /></a></p>
<p>This module adds architecture to support sending unique URLs to sponsor mobile devices for sponsoring a child during
an event. It adds the ability to make a hold on a child for a mobile phone number and providing a URL for a
mobile-friendly sponsor a child form.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#installation" id="id2">Installation</a></li>
<li><a class="reference internal" href="#configuration" id="id3">Configuration</a><ul>
<li><a class="reference internal" href="#development" id="id4">Development</a></li>
<li><a class="reference internal" href="#proxy" id="id5">Proxy</a></li>
</ul>
</li>
<li><a class="reference internal" href="#usage" id="id6">Usage</a></li>
<li><a class="reference internal" href="#load-tests" id="id7">Load Tests</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id8">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#changelog" id="id9">Changelog</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id10">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id11">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id12">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id13">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id14">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="installation"></a>
<h2><a class="toc-backref" href="#id2">Installation</a></h2>
<p>To install the module, you need to cd to <code>sms_sponsorship/webapp</code> and run the following commands :</p>
<blockquote>
npm install && npm run build</blockquote>
<p>Then, a new <code>build</code> folder will appear into <code>webapp</code>. If there is no <code>sms_sponsorship/static</code> symbolic link, run this command :</p>
<blockquote>
ln -s sms_sponsorship/webapp/build sms_sponsorship/static</blockquote>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id3">Configuration</a></h2>
<a name="development"></a>
<h3><a class="toc-backref" href="#id4">Development</a></h3>
<p>To develop for the react webapp, please follow these steps :
#. Use a code editor compatible with react (for exemple : WebStorm)
#. Open the project <code>sms_sponsorship/webapp</code>
#. If not already done, execute <code>npm install</code></p>
<p>To launch the app on the development server, run <code>npm start</code>.</p>
<a name="proxy"></a>
<h3><a class="toc-backref" href="#id5">Proxy</a></h3>
<p>In order for the development server to access odoo, it is necessary to add all
the odoo routes react needs in the file <code>package.json</code>.</p>
<p>Here is an exemple for <code>/sms_sponsorship_api</code> :</p>
<blockquote>
"proxy": { "/sms_sponsorship_api": { "target": "<a class="reference external" href="http://localhost:8069/">http://localhost:8069/</a>", "secure": false } }</blockquote>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id6">Usage</a></h2>
<p>To use this module, you need to:</p>
<ol class="arabic simple">
<li>Have a mobile app that can send messages to your Odoo instance</li>
</ol>
<a name="load-tests"></a>
<h2><a class="toc-backref" href="#id7">Load Tests</a></h2>
<p>Make a copy of the devel database</p>
<blockquote>
createdb -T devel new_db_name</blockquote>
<p>Duplicate the Odoo filestore as well (~/.local/share/Odoo/filestore/devel)</p>
<p>Launch an Odoo instance with that db</p>
<p>Start the load tests with</p>
<blockquote>
locust -f load_tests.py --host=http://localhost:8069</blockquote>
<p>It will start the load test server on localhost:8089</p>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id8">Known issues / Roadmap</a></h2>
<ul class="simple">
<li>Implement verifications for sponsor form</li>
</ul>
<a name="changelog"></a>
<h2 class="with-subtitle"><a class="toc-backref" href="#id9">Changelog</a></h2>
<h2 class="section-subtitle" id="id1"><span class="section-subtitle">10.0.1.0.0 (2018-07-09)</span></h2>
<ul class="simple">
<li>[ADD] Add the module</li>
</ul>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id10">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:%20sms_sponsorship%0Aversion:%20devel%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="#id11">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id12">Authors</a></h3>
<ul class="simple">
<li>Compassion CH</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id13">Contributors</a></h3>
<ul class="simple">
<li>Quentin Gigon <<a class="reference external" href="mailto:gigon.quentin@gmail.com">gigon.quentin@gmail.com</a>></li>
<li>Nicolas Bornand</li>
<li>Samuel Fringeli <<a class="reference external" href="mailto:samuel.fringeli@me.com">samuel.fringeli@me.com</a>></li>
<li>Emanuel Cino <<a class="reference external" href="mailto:ecino@compassion.ch">ecino@compassion.ch</a>></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id14">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/devel/sms_sponsorship">CompassionCH/{compassion-modules}</a> project on GitHub.</p>