ABank

Banking application

---

---

Stack

• client
  • React/Redux
• API
  • ExpressJs
  • MongoDb

---

Tools

• Swagger

---

Project requirements & Development roadmap

• Please visit roadmap

---

---

INSTALL & RUN

---

# clone repo
git clone https://github.com/GitHubAgneska/HAgnesGenay_13_19112020.git
#install api dependencies
npm i
#install client dependencies
npm run install-client

---

Run

---

npm run start-app

---

---

+------------------+
| ABANK DATA FLOW  |
+------------------+

    +----------------------------------------------------------------------+
    |                           MONGODB                                    |
    +-------------------------------+--------------------------------------+
    |  DB (MONGO) OC : DEV          |   DB (MONGO) PRIVATE : PROD          |
    +----------------^--------------+----------------^---------------------+
                     |                               |
                 +---+-------------------------------+---+
                 |          (MONGOOSE ORM)               |
                 +---+-------------------------------+---+
                     |                               |
                 +---+-------------------------------+---+
                 | ---------- EXPRESS  --------          |
                 +---+-------------------------------+---+
                     |                               |
 +-------------------v-------------------------------v-----------------------+
 |                            API                                            |
 +---------------------------------------------------------------------------+
 |  Base-URL: localhost:3001/api/v1/user                                     |
 |                                                                           |
 |            ---------------------/login                                    |
 |            ---------------------/signup                                   |
 |            ---------------------/profile/:id                              |
 |        + not yet implemented:                                             |
 |            ---------------------/profile/:id/account/:id                  |
 |            ---------------------/profile/:id/account/:id/transaction/:id  |
 |                                                                           |
 +------------------------------^--------------------------------------------+
                                |
                                |
 +------------------------------v---------------------------------------------+
 |  CLIENT (REACT)                                                            |
 +----------------------------------------------------------------------------+
 |                                                                            |
 |  Base-URL -----------------                                                |
 |           -----------------/home                                           |
 |           -----------------/signin                                         |
 |           -----------------/signup                                         |
 |           -----------------/user/:id  --->FETCH USERDATA : POST request    |
 |           -----------------/user/:id  --->EDIT  USERDATA : PUT  request    |
 |                                                                            |
 |        + not yet implemented:                                              |
 |           ----------------/user/:id/account/:id                            |
 |                        |--->FETCH USER_ACCOUNT : POST request              |
 |                                                                            |
 |           ----------------/user/:id/account/:id/transaction/:id            |
 |                        |--->FETCH USER_ACCOUNT_TRANSACTION : POST request  |
 |                                                                            |
 +----------------------------------------------------------------------------+