View source for Repo comfac-webshop DirectoryMap

= Repo:comfac-webshop/DirectoryMap — Directory Structure =

== Top-Level Structure ==

{| class="wikitable"
! Path !! Purpose !! Edit Frequency
|-
| <code>webshop/</code> || Main app code — e-commerce logic || 🟢 YOU WILL EDIT THIS
|-
| <code>webshop/public/</code> || CSS, JS, images for website || 🟢 YOU WILL EDIT THIS
|-
| <code>webshop/templates/</code> || Jinja2 HTML templates || 🟢 YOU WILL EDIT THIS
|-
| <code>webshop/www/</code> || Web page controllers || 🟢 YOU WILL EDIT THIS
|-
| <code>setup/</code> || Installation scripts || 🔵 GOOD TO KNOW
|-
| <code>patches/</code> || Database migrations || 🔵 GOOD TO KNOW
|-
| <code>.github/</code> || CI/CD workflows || ⚫ IGNORE
|}

== The 20% You'll Actually Use ==

=== Core Directories ===

{| class="wikitable"
! Path !! What It Contains !! When You'd Edit Here
|-
| <code>webshop/hooks.py</code> || App configuration, website routes, overrides || Changing URLs, adding event handlers
|-
| <code>webshop/webshop/doctype/</code> || Webshop DocTypes: Website Item, Wishlist, etc. || Adding product fields, wishlist features
|-
| <code>webshop/webshop/shopping_cart/</code> || Cart, checkout, order logic || Modifying cart behavior, checkout flow
|-
| <code>webshop/webshop/crud_events/</code> || Event handlers for ERPNext docs || Syncing Item changes to Website Item
|-
| <code>webshop/webshop/product_data_engine/</code> || Product search, filtering, listing || Customizing product display, search
|-
| <code>webshop/www/</code> || Website pages (all, cart, checkout) || Changing page layouts, adding new pages
|-
| <code>webshop/templates/</code> || Jinja templates for all pages || Modifying HTML structure, styling
|-
| <code>webshop/public/scss/</code> || SASS stylesheets || Changing colors, fonts, responsive design
|}

=== Key DocType Locations ===

Webshop DocTypes (in <code>webshop/webshop/doctype/</code>):

{| class="wikitable"
! DocType !! Purpose
|-
| <code>website_item/</code> || Products displayed on the storefront
|-
| <code>webshop_settings/</code> || Store configuration (currency, price list, etc.)
|-
| <code>wishlist/</code>, <code>wishlist_item/</code> || Customer wishlist functionality
|-
| <code>item_review/</code> || Product reviews and ratings
|-
| <code>website_offer/</code> || Promotions and discounts
|-
| <code>homepage_featured_product/</code> || Featured products on homepage
|-
| <code>recommended_items/</code> || Product recommendations
|}

Override DocTypes (in <code>webshop/webshop/doctype/override_doctype/</code>):
* <code>item.py</code>, <code>item_group.py</code> — Override ERPNext Item/Item Group
* <code>payment_request.py</code> — Override payment handling

=== Shopping Cart System ===

{| class="wikitable"
! File !! Purpose
|-
| <code>shopping_cart/cart.py</code> || Core cart operations (add, remove, update)
|-
| <code>shopping_cart/cart_address.py</code> || Shipping/billing address handling
|-
| <code>shopping_cart/product_info.py</code> || Product availability, pricing
|-
| <code>utils/</code> || Helper functions for cart and products
|}

=== Website Pages (www/) ===

{| class="wikitable"
! Path !! Purpose
|-
| <code>www/all-products/</code> || Product listing page
|-
| <code>www/cart/</code> || Shopping cart page
|-
| <code>www/checkout/</code> || Checkout process
|-
| <code>www/orders/</code> || Order history
|-
| <code>www/wishlist/</code> || Wishlist page
|-
| <code>www/item/</code> || Individual product page (via website_generator)
|}

=== Templates Structure ===

{| class="wikitable"
! Path !! Purpose
|-
| <code>templates/webshop/</code> || Main webshop templates
|-
| <code>templates/includes/</code> || Reusable components (navbar, footer, product cards)
|-
| <code>templates/pages/</code> || Static page layouts
|}

=== Frontend Assets (public/) ===

{| class="wikitable"
! Path !! Purpose
|-
| <code>public/scss/</code> || SASS stylesheets
|-
| <code>public/js/</code> || JavaScript (product page, cart interactions)
|}

== File Types Present ==

{| class="wikitable"
! Extension !! Meaning in This Project
|-
| <code>.json</code> (in doctype folders) || DocType schema definitions
|-
| <code>.py</code> || Python controllers, server-side logic
|-
| <code>.html</code> || Jinja2 templates
|-
| <code>.scss</code> || SASS stylesheets
|-
| <code>.js</code> || Client-side JavaScript
|-
| <code>.md</code> || Documentation
|}

== Important: Where Config vs Code Lives ==

* '''DocType JSON files''' (<code>*/doctype/*/*.json</code>) define the '''structure''' (fields, types, labels)
* '''Python controllers''' (<code>*/doctype/*/*.py</code>) define '''behavior''' (validation, calculations)
* '''www/ files''' define '''web routes and page logic'''
* '''templates/ files''' define '''HTML presentation'''
* '''public/ files''' define '''CSS and client-side JS'''
* '''hooks.py''' wires everything together

== Directories to Ignore ==

* <code>__pycache__/</code> — Python bytecode
* <code>.git/</code> — Version control
* <code>node_modules/</code> — NPM packages
* Compiled CSS in <code>public/dist/</code>

== Related Pages ==

* [[Repo_comfac-webshop_Overview]] — Project overview
* [[Repo_comfac-webshop_EntryPoints]] — How the app starts
* [[Repo_comfac-webshop_DataModel]] — DocTypes and data model
* [[Repo_comfac-webshop_ExtensionPoints]] — Hooks and customization points
* [[Repo_comfac-webshop_CommonEdits]] — Common edit recipes

[[Category:Repository Analysis]]