interpos-web-client
v0.0.96
Published
Common UI library containing POS components used across Inter products
Downloads
4,655
Readme
Interpos Web Client
This is a repository containing standalone app for InterPOS, as well as a reusable library for importing POS into Orchestra projects.
Used as library
Make sure you understand how this works before implementing.
POS module has it's own store for redux provider. It wraps <PosEntryPoint />
which needs to be called as a root route.
Example:
<Route path={SecureRoutes.Pos.All} element={<PosPage />}>
<Route
path={SecureRoutes.Pos.Overview}
element={<PosGeneralOverviewPage />}
/>
<Route
path={SecureRoutes.Pos.Integrations}
element={<PosIntegrationsPage />}
/>
<Route
path={SecureRoutes.Pos.TaxRates}
element={<PosTaxRatesPage />}
/>
<Route path={SecureRoutes.Pos.List} element={<PosListPage />} />
<Route
path={SecureRoutes.Pos.Settings}
element={<PosSettingsPage />}
/>
<Route path={SecureRoutes.Pos.Items} element={<PosItemsPage />} />
<Route
path={SecureRoutes.Pos.Buyers}
element={<PosBuyersPage />}
/>
<Route
path={SecureRoutes.Pos.Invoices}
element={<PosInvoicesPage />}
/>
<Route
path={SecureRoutes.Pos.CreateInvoice}
element={<PosIssueInvoicePage />}
/>
<Route
path={SecureRoutes.Pos.RefundInvoice}
element={<PosRefundInvoicePage />}
/>
<Route
path={SecureRoutes.Pos.InvoiceDetails}
element={<PosInvoiceDetailsPage />}
/>
</Route>
Make sure you have all these pages implemented.
Exported containers and components to be used:
- PosEntryPoint
- PosGeneralOverviewContainer
- PosIntegrationsPage
- PosTaxRatesPage
- PosListPage
- PosSettingsPage
- PosItemsPage
- PosBuyersPage
- PosInvoicesPage
- PosIssueInvoicePage
- PosRefundInvoicePage
- PosInvoiceDetailsPage
Redux state
Library version is relying on redux store. It's type is defined in index.ts, in store folder. Make sure you app has store with that type loaded.
Environment variables
Library version is relying on consumer's env variables. Make sure you understand which are those and have them loaded.
Branches
main
- production standalone
dev
- staging standalone
library
- production library, triggers deployment to npm registry