diff options
| author | tanhengyeow <E0032242@u.nus.edu> | 2020-08-26 15:24:13 +0800 |
|---|---|---|
| committer | tanhengyeow <E0032242@u.nus.edu> | 2020-08-26 15:24:13 +0800 |
| commit | 682d001071e55d963ad235e04881224303c5adb8 (patch) | |
| tree | d168d6e99043152c8fd03b23a2454df37f742957 /libeufin/frontend.rst | |
| parent | 182b22d39d685c00012367bf74e767f3b74e61a0 (diff) | |
| download | docs-682d001071e55d963ad235e04881224303c5adb8.tar.gz docs-682d001071e55d963ad235e04881224303c5adb8.tar.bz2 docs-682d001071e55d963ad235e04881224303c5adb8.zip | |
Initial docs for frontend project
Diffstat (limited to 'libeufin/frontend.rst')
| -rw-r--r-- | libeufin/frontend.rst | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/libeufin/frontend.rst b/libeufin/frontend.rst new file mode 100644 index 00000000..a3ab6d54 --- /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. |