summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authortanhengyeow <E0032242@u.nus.edu>2020-08-26 15:24:13 +0800
committertanhengyeow <E0032242@u.nus.edu>2020-08-26 15:24:13 +0800
commit682d001071e55d963ad235e04881224303c5adb8 (patch)
treed168d6e99043152c8fd03b23a2454df37f742957
parent182b22d39d685c00012367bf74e767f3b74e61a0 (diff)
downloaddocs-682d001071e55d963ad235e04881224303c5adb8.tar.gz
docs-682d001071e55d963ad235e04881224303c5adb8.tar.bz2
docs-682d001071e55d963ad235e04881224303c5adb8.zip
Initial docs for frontend project
-rw-r--r--libeufin/concepts.rst2
-rw-r--r--libeufin/frontend.rst45
-rw-r--r--libeufin/index.rst1
3 files changed, 47 insertions, 1 deletions
diff --git a/libeufin/concepts.rst b/libeufin/concepts.rst
index da48d7f..b9c76c5 100644
--- a/libeufin/concepts.rst
+++ b/libeufin/concepts.rst
@@ -19,7 +19,7 @@ LibEuFin has two main components:
format via an HTTP API. It then translates those requests into interactions
with other banking APIs, abstracting away different underlying protocols and
hiding the complexity of the legacy protocols used by some banks.
-
+
2. The LibEuFin sandbox implements the server side of protocols
that banks speak. It also emulates a *very*, *very* simple
core banking system to manage accounts and their balance.
diff --git a/libeufin/frontend.rst b/libeufin/frontend.rst
new file mode 100644
index 0000000..a3ab6d5
--- /dev/null
+++ b/libeufin/frontend.rst
@@ -0,0 +1,45 @@
+###################
+LibEuFin Frontend
+###################
+
+Introduction
+================
+
+LibEuFin Frontend is a Single Page Application (SPA) built using React that facilitates setting up access to bank accounts, querying/displaying the transaction history of bank accounts and initiating payments.
+
+Architecture
+===============
+
+The frontend code sits in the `/frontend` folder. Files in the subfolders are highlighted below.
+
+/actions, /reducers folder
+--------------------------
+Contains code that uses Redux to store the login state. Prevents user from relogging in every time they closed the browser or browser tab.
+
+/routes folder
+--------------
+Directs the user to the respective pages according to the URL route. Routes are broken down into `UnauthenticatedRoute` and `AuthenticatedRoute`, which corresponds to the user's login state.
+
+/components/login
+-----------------
+The login page for the user.
+
+/components/navbar
+------------------
+Reusable navbar component that appears on every page of the project.
+
+/components/footer
+------------------
+Reusable footer component that appears on every page of the project.
+
+components/home
+---------------
+The home page showing general information of the users for e.g. bank accounts set up.
+
+/components/activity
+--------------------
+Shows activity of payments and its transaction history (WIP).
+
+/components/bank-accounts
+-------------------------
+Shows bank accounts that are imported. A bank account drawer is shown to facilitate setting up of bank accounts. Each bank account is displayed in a card to display extra details for e.g its' print document.
diff --git a/libeufin/index.rst b/libeufin/index.rst
index 766410e..4dab2a3 100644
--- a/libeufin/index.rst
+++ b/libeufin/index.rst
@@ -15,3 +15,4 @@ LibEuFin is a project providing free software tooling for European FinTech.
iso20022
banking-protocols
transaction-identification
+ frontend