<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="#development" id="id2">Development</a></li> <li><a class="reference internal" href="#proxy" id="id3">Proxy</a><ul> <li><a class="reference internal" href="#usage" id="id4">Usage</a></li> <li><a class="reference internal" href="#load-tests" id="id5">Load Tests</a></li> <li><a class="reference internal" href="#known-issues-roadmap" id="id6">Known issues / Roadmap</a></li> <li><a class="reference internal" href="#changelog" id="id7">Changelog</a></li> </ul> </li> <li><a class="reference internal" href="#id1" id="id8">10.0.1.0.0 (2018-07-09)</a><ul> <li><a class="reference internal" href="#bug-tracker" id="id9">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id10">Credits</a></li> </ul> </li> <li><a class="reference internal" href="#authors" id="id11">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id12">Contributors</a></li> <li><a class="reference internal" href="#maintainers" id="id13">Maintainers</a></li> </ul> </div> <a name="development"></a> <h2><a class="toc-backref" href="#id2">Development</a></h2> <p>To develop for the react webapp, please follow these steps :</p> <ol class="arabic simple"> <li>Use a code editor compatible with react (for exemple : WebStorm)</li> <li>Open the project sms_sponsorship/webapp</li> <li>If not already done, execute npm install</li> </ol> <p>To launch the app on the development server, run npm start.</p> <p>To publish the changes:</p> <blockquote> npm install &amp;&amp; npm run build</blockquote> <p>Then, a new build folder will appear into webapp. Copy the build folder into the static folder to make it available and rename it to react.</p> <a name="proxy"></a> <h2><a class="toc-backref" href="#id3">Proxy</a></h2> <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> &quot;proxy&quot;: { &quot;/sms_sponsorship_api&quot;: { &quot;target&quot;: &quot;<a class="reference external" href="http://localhost:8069/">http://localhost:8069/</a>&quot;, &quot;secure&quot;: false } }</blockquote> <a name="usage"></a> <h3><a class="toc-backref" href="#id4">Usage</a></h3> <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> <h3><a class="toc-backref" href="#id5">Load Tests</a></h3> <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> <h3><a class="toc-backref" href="#id6">Known issues / Roadmap</a></h3> <ul class="simple"> <li>Implement verifications for sponsor form</li> </ul> <a name="changelog"></a> <h3><a class="toc-backref" href="#id7">Changelog</a></h3> <a name="id1"></a> <h2><a class="toc-backref" href="#id8">10.0.1.0.0 (2018-07-09)</a></h2> <ul class="simple"> <li>[ADD] Add the module</li> </ul> <a name="bug-tracker"></a> <h3><a class="toc-backref" href="#id9">Bug Tracker</a></h3> <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> <h3><a class="toc-backref" href="#id10">Credits</a></h3> <a name="authors"></a> <h2><a class="toc-backref" href="#id11">Authors</a></h2> <ul class="simple"> <li>Compassion CH</li> </ul> <a name="contributors"></a> <h2><a class="toc-backref" href="#id12">Contributors</a></h2> <ul class="simple"> <li>Quentin Gigon &lt;<a class="reference external" href="mailto:gigon.quentin&#64;gmail.com">gigon.quentin&#64;gmail.com</a>&gt;</li> <li>Nicolas Bornand</li> <li>Samuel Fringeli &lt;<a class="reference external" href="mailto:samuel.fringeli&#64;me.com">samuel.fringeli&#64;me.com</a>&gt;</li> <li>Emanuel Cino &lt;<a class="reference external" href="mailto:ecino&#64;compassion.ch">ecino&#64;compassion.ch</a>&gt;</li> </ul> <a name="maintainers"></a> <h2><a class="toc-backref" href="#id13">Maintainers</a></h2> <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>