Skip to content

Commit

Permalink
add an html description, update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gurneyalex committed May 24, 2015
1 parent 6aa2bb7 commit ca236d8
Show file tree
Hide file tree
Showing 5 changed files with 206 additions and 11 deletions.
38 changes: 27 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,39 @@
[![Coverage Status](https://coveralls.io/repos/OCA/vertical-ngo/badge.png?branch=8.0)](https://coveralls.io/r/OCA/vertical-ngo?branch=8.0)


This project aim to develop and publish all modules related to the need of humanitarian NGOs. It would cover the overall needs in terms of logistics, order management, accounting, transportation and distribution.

Main changes are made in the procurement standard flow of Odoo. Usually, you have sales that drive procurement, that drive purchase. With those modules, you record logistic requisition to capture the needs, you source them from one way or another (purchase, stock, donnation,..) and give back to the requestor the price, time and product information. If he agree with, then you confirm the requisition by creating an offer. The offer will drive all the necessary flow to deliver the good where they are needed. It also improve the purchase requisition flow to fit more with the NGO's problematic.

In the future, it'll cover other NGO's specific needs such as the distribution, transportation, finance (donations, donors report,.. ), volonteer management,..
This project aim to develop and publish all modules related to the need of
humanitarian NGOs. It would cover the overall needs in terms of logistics,
order management, accounting, transportation and distribution.

Main changes are made in the procurement standard flow of Odoo. Usually, you
have sales that drive procurement, that drive purchase. With those modules, you
record logistic requisition to capture the needs, you source them from one way
or another (purchase, stock, donnation,..) and give back to the requestor the
price, time and product information. If he agree with, then you confirm the
requisition by creating an offer. The offer will drive all the necessary flow
to deliver the good where they are needed. It also improve the purchase
requisition flow to fit more with the NGO's problematic.

In the future, it'll cover other NGO's specific needs such as the distribution,
transportation, finance (donations, donors report,.. ), volonteer management,..

You'll find here :
----------------------

- NGO Addons: That contain the module specific to the NGO world (currently management of logistic reuquisition, kind of need registring and sourcing tools)
- NGO Addons: That contain the module specific to the NGO world (currently
management of logistic reuquisition, kind of need registring and sourcing
tools)


Other related community project where we put some useful module for NGO as well:
--------------------------------------------------------------------------------------------------------------------
Other related community project where we put some useful module for NGO as well
-------------------------------------------------------------------------------

* https://github.com/OCA/stock-logistics-warehouse : module `stock_reserve` and `stock_reserve_sale`, `stock_location_ownership`
* https://github.com/OCA/stock-logistics-warehouse : module `stock_reserve`
and `stock_reserve_sale`, `stock_location_ownership`

* https://github.com/OCA/stock-logistics-workflow : module `stock_split_picking`
* https://github.com/OCA/stock-logistics-workflow : module
`stock_split_picking`

* https://github.com/OCA/sale-workflow : module `sale_validity`, `sale_quotation_sourcing`, `sale_sourced_by_line`, `sale_exception_nostock`, `sale_cancel_reason`, `partner_prepayment`
* https://github.com/OCA/sale-workflow : module `sale_validity`,
`sale_quotation_sourcing`, `sale_sourced_by_line`, `sale_exception_nostock`,
`sale_cancel_reason`, `partner_prepayment`
8 changes: 8 additions & 0 deletions vertical_ngo/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ To configure this module, go to Settings -> NGO and perform the required
configuration.


Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/vertical-ngo/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
`here <https://github.com/OCA/vertical-ngo/issues/new?body=module:%20framework_agreement_sourcing%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Credits
=======

Expand Down
171 changes: 171 additions & 0 deletions vertical_ngo/static/description/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
<section class="oe_container">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<h2 class="oe_slogan">Odoo Verticalization for NGO</h2>
<p>This project aim to develop and publish all modules related to the
need of humanitarian NGOs. It would cover the overall needs in terms of
logistics, order management, accounting, transportation and
distribution.
</p>

<p>Main changes are made in the procurement standard flow of
Odoo. Usually, you have sales that drive procurement, that drive
purchase. With those modules, you record logistic requisition to
capture the needs, you source them from one way or another (purchase,
stock, donnation,..) and give back to the requestor the price, time and
product information. If he agree with, then you confirm the requisition
by creating an offer. The offer will drive all the necessary flow to
deliver the good where they are needed. It also improve the purchase
requisition flow to fit more with the NGO's problematic.</p>

<p>In the future, it will cover other NGO's specific needs such as the
distribution, transportation, finance (donations, donors report&hellip;),
volonteer management&hellip;</p>

</div>
</div>
</section>

<section class="oe_container oe_dark">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<h2 class="oe_slogan">Installation</h2>
</div>
<div class="oe_span6">
<p class="oe_mt32">To install this module, you need to ensure that
the following projects are in your addons path:
<ul>
<li><a href="https://github.com/OCA/purchase-workflow">purchase-workflow</a></li>
<li><a href="https://github.com/OCA/sale-workflow">sale-workflow</a> (https://github.com/OCA/sale-workflow)</li>
<li><a href="https://github.com/OCA/stock-logistics-workflow">stock-logistics-workflow</a></li>
<li><a href="https://github.com/OCA/stock-logistics-transport">stock-logistics-transport</a></li>
</ul>

and optionally:
<ul>
<li>
<a href="https://github.com/OCA/department">department</a>:
to manage logistic requiritions by department
</li>
<li>
<a href="https://github.com/OCA/stock-logistics-warehouse">stock-logistics-warehouse</a>
for modules such as
<span class="oe_emph">stock_reserve</span>,
<span class="oe_emph">stock_reserve_sale</span>,
<span class="oe_emph">stock_location_ownership</span>&hellip;
</li>
<li>
<a href="https://github.com/OCA/stock-logistics-workflow">stock-logistics-worflow</a>
for modules such as
<span class="oe_emph">stock_split_picking</span>&hellip;
</li>
<li>
<a href="https://github.com/OCA/sale-workflow">sale-workflow</a>
for modules such as
<span class="oe_emph">sale_validity</span>,
<span class="oe_emph">sale_quotation_sourcing</span>,
<span class="oe_emph">sale_sourced_by_line</span>,
<span class="oe_emph">sale_exception_nostock</span>,
<span class="oe_emph">sale_cancel_reason</span>,
<span class="oe_emph">partner_prepayment</span>&hellip;
</li>
</ul>
</p>
</div>
<div class="oe_span6">
<div class="oe_demo oe_picture oe_screenshot">
<a href="https://runbot.odoo-community.org/runbot/1/8.0">
<img src="icon.png">
</a>
</div>
</div>
</div>
</section>

<section class="oe_container">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<h2 class="oe_slogan">Configuration</h2>
</div>
<div class="oe_span6">
<p class="oe_mt32">To configure this module, you need to:
<ul>
<li>Go to Settings -> NGO, and select the features you
want to use.</li>
</ul>
</p>
</div>
<div class="oe_span6">
<div class="oe_demo oe_picture oe_screenshot">
<a href="https://www.openerp.com/saas_master/demo?lang=en_US&module=crm">
<img src="vertical-ngo-settings.png">
</a>
</div>
</div>
</div>
</section>

<section class="oe_container oe_dark">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<h2 class="oe_slogan">Usage</h2>
</div>
<div class="oe_span6">
<p class="oe_mt32">To use this module, you need to go to the order
management menu. All the main functions are conveniently available
in there
<ul>
<li>creation of logistics requisitions</li>
<li>sourcing of logistics requisitions lines</li>
<li>management of cost estimates and logistics orders</li>
<li>shipment management</li>
</ul>
</p>
<p class="oe_mt32">For further information, please visit:
<ul>
<li><a href="https://www.odoo.com/forum/help-1">https://www.odoo.com/forum/help-1</a></li>
</ul>
</p>
</div>
<div class="oe_span6">
<div class="oe_demo oe_picture oe_screenshot">
<a href="https://www.openerp.com/saas_master/demo?lang=en_US&module=crm">
<img src="vertical-ngo_LR.png">
</a>
</div>
</div>
</div>
</section>

<section class="oe_container">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<h2 class="oe_slogan">Known issues / Roadmap</h2>
</div>
<div class="oe_span6">
<p class="oe_mt32">
<ul>
<li>support more activities for NGOs</li>
</ul>
</p>
</div>
</div>
</section>

<section class="oe_container oe_dark">
<div class="oe_row">
<div class="oe_span12">
<h3>Maintainer</h3>
<p>
This module is maintained by the OCA.<br/>

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.<br/> To contribute to this module, please
visit <a href="http://odoo-community.org">http://odoo-community.org</a>.<br/>
<a href="http://odoo-community.org"><img class="oe_picture oe_centered" src="http://odoo-community.org/logo.png"></a>
</p>
</div>
</div>
</section>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ca236d8

Please sign in to comment.