summaryrefslogtreecommitdiff
path: root/packages/backend
diff options
context:
space:
mode:
authorSebastian <sebasjm@gmail.com>2021-10-01 10:14:44 -0300
committerSebastian <sebasjm@gmail.com>2021-10-01 10:14:44 -0300
commit549d7f20cbb2f559611569466123f3fa2459bb0d (patch)
tree8e046da8673adb8f525f86050d4a6ce5e96d2b12 /packages/backend
parentb783e7219cc6ee4ae60301f560e2edf6cc44a489 (diff)
downloadmerchant-backoffice-549d7f20cbb2f559611569466123f3fa2459bb0d.tar.gz
merchant-backoffice-549d7f20cbb2f559611569466123f3fa2459bb0d.tar.bz2
merchant-backoffice-549d7f20cbb2f559611569466123f3fa2459bb0d.zip
fixed rollup, added README
Diffstat (limited to 'packages/backend')
-rw-r--r--packages/backend/README.md30
-rw-r--r--packages/backend/rollup.config.js8
2 files changed, 34 insertions, 4 deletions
diff --git a/packages/backend/README.md b/packages/backend/README.md
new file mode 100644
index 0000000..16cbd0b
--- /dev/null
+++ b/packages/backend/README.md
@@ -0,0 +1,30 @@
+Merchant Backend pages
+
+# Description
+
+This project generate 5 templates for the merchant backend:
+
+ * DepletedTip
+ * OfferRefund
+ * OfferTip
+ * RequestPayment
+ * ShowOrderDetails
+
+This pages are to be serve from the merchant-backend service and will be queried for browser that may or may not have javascript enabled, so we are going to do server side rendering.
+The merchant-backend service is currently supporting mustache library for server side rendering.
+We also want the be able to create a more interactive design if the browser have javascript enabled, so the pages will be serve with all the infromation in the html but also in javascript.
+
+In this scenario, we are using jsx to build the template of the page that will be build-time rendered into the mustache template. This template can the be deployed into a merchant-backend that will complete the information before send it to the browser.
+
+# Building
+
+The building process can be executed with `pnpm build`
+
+# Testing
+
+This project is using a javascript implementation of mustache that can be executed with the command `pnpm render-examples`.
+This script will take the pages previously built in `dist/pages` directory and the examples definition in the `src/pages/[exampleName].examples.ts` files and render a to-be-sent-to-the-user page like the merchant would do.
+This examples will be saved invidivualy into directory `dist/examples` and should be opened with your testing browser.
+Testing should be done with javascript enabled and javascript disabled, both should look ok.
+
+
diff --git a/packages/backend/rollup.config.js b/packages/backend/rollup.config.js
index a324422..f5227ba 100644
--- a/packages/backend/rollup.config.js
+++ b/packages/backend/rollup.config.js
@@ -104,9 +104,9 @@ const pageDefinition = (name) => ({
});
export default [
- // pageDefinition("OfferTip"),
- // pageDefinition("OfferRefund"),
- // pageDefinition("DepletedTip"),
- // pageDefinition("RequestPayment"),
+ pageDefinition("OfferTip"),
+ pageDefinition("OfferRefund"),
+ pageDefinition("DepletedTip"),
+ pageDefinition("RequestPayment"),
pageDefinition("ShowOrderDetails"),
]