https://mediawiki.comfac.net/index.php?action=history&feed=atom&title=Webshop-01-Architecture-Overview
Webshop-01-Architecture-Overview - Revision history
2026-06-05T11:02:43Z
Revision history for this page on the wiki
MediaWiki 1.45.1
https://mediawiki.comfac.net/index.php?title=Webshop-01-Architecture-Overview&diff=159&oldid=prev
Justinaquino: "Add all 14 Frappe ERPNext Webshop chapter pages from wikitext-upload"
2026-03-06T13:00:41Z
<p>"Add all 14 Frappe ERPNext Webshop chapter pages from wikitext-upload"</p>
<p><b>New page</b></p><div>= 01 - Architecture Overview =<br />
<br />
'''Parent:''' [Webshop-Index Webshop Index] <br />
'''Source:''' [https://github.com/Comfac-Global-Group/comfac-webshop/wiki/01-Architecture-Overview Comfac Webshop Wiki - Chapter 01]<br />
<br />
----<br />
<br />
== Framework Stack ==<br />
<br />
- '''Frappe Framework''' - Python/JS full-stack framework<br />
- Server: Python 3, MariaDB/PostgreSQL<br />
- ORM: Frappe DocType system (metadata-driven)<br />
- Web: Jinja2 templates, jQuery frontend<br />
- API: Whitelisted Python functions exposed as REST endpoints<br />
- '''ERPNext''' - ERP layer providing Item, Customer, Quotation, Sales Order, Pricing Rule, etc.<br />
- '''Payments''' - Payment gateway integration<br />
<br />
== How the App Integrates ==<br />
<br />
The webshop is a '''Frappe app''' installed alongside ERPNext. It:<br />
<br />
1. '''Overrides ERPNext DocTypes''' via <code>override_doctype_class</code> in hooks.py:<br />
- <code>Item</code> -> adds website publishing fields<br />
- <code>Item Group</code> -> adds website rendering (acts as category pages)<br />
- <code>Payment Request</code> -> customized payment flow<br />
<br />
2. '''Hooks into doc_events''' for Quotation (validate cart items), Item (sync Website Item), Price List, Tax Rule<br />
<br />
3. '''Provides website generators''' for <code>Website Item</code> and <code>Item Group</code> (auto-generates web pages from DocType records)<br />
<br />
4. '''Registers web pages''' at:<br />
- <code>/all-products</code> - product listing with filters<br />
- <code>/shop-by-category</code> - category browsing<br />
- <code>/cart</code> - shopping cart page<br />
- <code>/orders</code> - order history<br />
- <code>/wishlist</code> - saved items<br />
- <code>/<item-route></code> - individual product pages (generated)<br />
- <code>/<item-group-route></code> - category pages (generated)<br />
<br />
== Data Flow Summary ==<br />
<br />
<pre><br />
Website Item (published product)<br />
|<br />
v<br />
Product Page (variant selector if template item)<br />
|<br />
v<br />
Add to Cart -> Quotation (order_type="Shopping Cart", docstatus=0)<br />
| - Quotation Item rows (item_code, qty, rate, amount)<br />
| - Pricing rules applied via ERPNext<br />
| - Taxes calculated<br />
v<br />
Place Order -> Quotation.submit() -> Sales Order created<br />
|<br />
v<br />
Payment (if checkout enabled) -> Payment Request<br />
<pre><br />
<br />
== Key Design Decisions ==<br />
<br />
=== 1. Cart = Quotation ===<br />
The shopping cart IS an ERPNext Quotation document with <code>order_type="Shopping Cart"</code>. All pricing, taxes, and discounts flow through ERPNext's standard Quotation logic.<br />
<br />
=== 2. Website Item vs Item ===<br />
ERPNext <code>Item</code> is the master. <code>Website Item</code> is a separate DocType that links to <code>Item</code> and adds web-specific fields (route, images, description). This allows selective publishing.<br />
<br />
=== 3. Variant Handling ===<br />
Uses ERPNext's Item Variant system. Template items show a configurator; variant items are the actual purchasable products. Variant data is cached in Redis.<br />
<br />
=== 4. No SPA ===<br />
Traditional server-rendered pages with jQuery for interactivity. Cart updates happen via AJAX calls that return re-rendered HTML fragments.<br />
<br />
----<br />
<br />
'''Next:''' [Webshop-02-DocTypes 02 - DocTypes]</div>
Justinaquino