EdeeShop modul

EdeeShop modul

Tato sekce obsahuje informace, které jsou potřebné pro začátek práce s modulem EdeeShop z pohledu aplikačního vývojáře.

Modul EdeeShop je součástí platformy Edee.one a je určen pro vývoj e-shopů. Modul obsahuje veškerou logiku pro práci s produkty, objednávkami, košíkem, uživateli a dalšími funkcionalitami, které jsou potřebné pro provoz e-shopu.

Funkční specifikaci modulu EdeeShop je k dispozici zde.

Zkopírovat odkaz na sekciInstalace modulu

Následující kroky popisují, jak nainstalovat modul EdeeShop do projektu. Instalace samotné platformy Edee.one ke k dispozici zde.

Zapnout module obnáší následující kroky:

1. Inicializace projektu - vytvoření nového projektu, jako vzor či inspiraci lze použít skeleton.

2. Závislost na EdeeShop modulu - přidat/upravit závislost na modulu EdeeShop v projektovém pom.xml, například:

   xml

   1 <dependency>2    <groupId>com.fg.cps.eshop</groupId>3    <artifactId>lib_eshop</artifactId>4    <version>${eshop.version}</version>5    <type>pom</type>6</dependency>

   Přehled verzí modulu EdeeShop naleznete zde. Obsahuje informace o změnách, novinkách a kompatibilitě s ostatními moduly.

Zkopírovat odkaz na sekciArchitektura modulu

Zkopírovat odkaz na sekciFeatures (rozšíření)

Module EdeeShop je rozdělen do menších funkčních celků, které se nazývají features (rozšíření). Každé rozšíření obsahuje logiku pro určitou funkcionalitu, například pro práci s produkty, objednávkami, nebo s košíkem.

Seznam všech rozšíření a jejich popis naleznete zde.

Jak vytvořit nové rozšíření naleznete zde.

Zkopírovat odkaz na sekciPrimární a publikovaná data

Modul EdeeShop pracuje s dvěma typy dat: primární a publikovaná data. Rozdíl mezi těmito daty je, kde jsou uložena a jaké je jejich určení.

Primární data jsou data, která jsou uložena v databázi a jsou určena pro definici a správu dat v rámci modulu EdeeShop. Jedná se o veškeré informace o produktech, kategoriích, objednávkách, uživatelích atd. se kterými modul pracuje.

Tato data je možné spravovat pomocí administrace modulu EdeeShop, nebo pomocí API.

Publikovaná data jsou vytvářena pomocí publikačního procesu z primárních dat, kdy jsou vybraná data z primárních dat transformována do podoby, která je vhodná pro zobrazení a práci na webu z hlediska rychlosti a efektivity.

Jedná se o data, která jsou zobrazena na webu e-shopu, jako například produkty, kategorie, parametry atd. nebo data, která jsou potřeba pro rychlou a efektivní práci na webu, jako například vyhledávání nebo nákupní proces.

Tedy s publikovanými daty by se mělo pracovat vždy pokud se jedná o zobrazení nebo práci s daty na webu.

Tato data jsou uložena v EvitaDb.

Data, která jsou publikována:

• E-shop entity, jejichž výčet je definován typem CatalogEntityType.
  Tyto entity implementují rozhraní EdeeShopEntity.
• Edee štítky

Zkopírovat odkaz na sekciPublikační proces

Zkopírovat odkaz na sekciCustomizace a rozšíření modulu

• Vytvoření nové feature
• Rozšíření modelu primární dat - TODO
• Projektové rozšíření schématu publikovaných dat
• Traity - rozšíření datového modulu
• Objednávky
• Přidání nového typu dopravy
• Zaokrouhlení částky k úhradě objednávky

Zkopírovat odkaz na sekciKonfigurace modulu

Konfigurace modulu EdeeShop je popsána v následujících částech:

• Konfigurace samotného EdeeShop modulu
• Konfigurace jednotlivých rozšíření
• Specifická konfigurace pro konkrétní katalog

Zkopírovat odkaz na sekciRestApi

EdeeShop modul poskytuje dvě základní části RestApi: backend a frontend. Každá část má své specifické využití a je určena pro různé typy operací.

Zkopírovat odkaz na sekciBackend API

Backend API je určeno především pro práci s primárními daty a slouží ke správě e-shopu, tedy administraci. Pomocí tohoto API lze spravovat produkty, objednávky, uživatele a další entity, které jsou klíčové pro provoz e-shopu. Více informací o backend API naleznete zde.

Zkopírovat odkaz na sekciFrontend API

Frontend API je určeno pro operace, které vykonává zákazník na frontendu e-shopu. Toto API pracuje jak s primárními, tak i s publikovanými daty. Umožňuje například vyhledávání produktů, přidávání položek do košíku, vytváření objednávek a další operace, které jsou nezbytné pro interakci zákazníka s e-shopem. Více informací o frontend API naleznete zde.

Zkopírovat odkaz na sekciTestování

Podpora pro integrační testy je popsána zde.

Zkopírovat odkaz na sekciReferenční dokumentace

Referenční dokumentace zde

Zkopírovat odkaz na sekciHow to

Pro návody a postupy, jak provést určité operace v modulu EdeeShop použijte https://q2a.fg.cz/e-shop.