[libeufin] branch master updated: Update README.md for the project

[gnunet]

This is an automated email from the git hooks/post-receive script.

heng-yeow pushed a commit to branch master
in repository libeufin.

The following commit(s) were added to refs/heads/master by this push:
     new 70a8767  Update README.md for the project
70a8767 is described below

commit 70a8767eff4c53ca5899025f797b45b0041297fa
Author: tanhengyeow <E0032242@u.nus.edu>
AuthorDate: Wed Aug 26 00:26:02 2020 +0800

    Update README.md for the project
---
 frontend/README.md | 50 ++++++++++++--------------------------------------
 1 file changed, 12 insertions(+), 38 deletions(-)

diff --git a/frontend/README.md b/frontend/README.md
index 64e343e..57ac5a5 100644
--- a/frontend/README.md
+++ b/frontend/README.md
@@ -1,44 +1,18 @@
-This project was bootstrapped with [Create React 
App](https://github.com/facebook/create-react-app).
+## LibEuFin Frontend
 
-## Available Scripts
+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.
 
-In the project directory, you can run:
+## System requirements
 
-### `yarn start`
+- Node version: 10.16.0
+- Npm version: 6.9.0
+- Yarn version: 1.22.4
 
-Runs the app in the development mode.<br />
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+## Installation
 
-The page will reload if you make edits.<br />
-You will also see any lint errors in the console.
+Note: The frontend calls the APIs of the Nexus server, which runs on port 
5000. Make sure that the Nexus server is running before executing these steps.
 
-### `yarn test`
-
-Launches the test runner in the interactive watch mode.<br />
-See the section about [running 
tests](https://facebook.github.io/create-react-app/docs/running-tests) for more 
information.
-
-### `yarn build`
-
-Builds the app for production to the `build` folder.<br />
-It correctly bundles React in production mode and optimizes the build for the 
best performance.
-
-The build is minified and the filenames include the hashes.<br />
-Your app is ready to be deployed!
-
-See the section about 
[deployment](https://facebook.github.io/create-react-app/docs/deployment) for 
more information.
-
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can 
`eject` at any time. This command will remove the single build dependency from 
your project.
-
-Instead, it will copy all the configuration files and the transitive 
dependencies (webpack, Babel, ESLint, etc) right into your project so you have 
full control over them. All of the commands except `eject` will still work, but 
they will point to the copied scripts so you can tweak them. At this point 
you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for 
small and middle deployments, and you shouldn’t feel obligated to use this 
feature. However we understand that this tool wouldn’t be useful if you 
couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App 
documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+1. Navigate to `/frontend`.
+2. Run `yarn install` to install the required dependencies for the project.
+3. Run `yarn start` to start the project.
+4. Go to `http://localhost:3000/` and use the app!

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.