Skip to content

Latest commit

 

History

History
103 lines (74 loc) · 4.1 KB

README.md

File metadata and controls

103 lines (74 loc) · 4.1 KB
Raw

Unicorn Finance

We have created Unicorn Finance as a sample application showcasing the capabilities of our J.P. Morgan core external APIs. We hit a number of J.P. Morgan APIs in the UAT and CAT environment via SSL authentication.

See our project running on AWS Amplify here

Screenshot of Unicorn Finance Account page

What APIs are you hitting?

  1. Service Status Page: We hit the Platform Availability Communication Management API on this page. This returns a list of current outages within J.P. Morgan external APIs. If no outages are returned a message is displayed for the user.
  2. Accounts Page: We hit two APIs on this page:
    • Balances: This API returns intraday balances for specific accounts. We use it to get the current day balance for a UAT account
    • Transactions: This API returns all the transactions for a specific account for a specific time period.
  3. Payments Page: We hit the Global Payments API to create a payment in CAT.

On each page you can use the bar at the bottom of the page to toggle 'What APIs are being used on this page' functionality. This will tell you exactly which API is being hit for each section. E.g for the account page: Screenshot of Unicorn Finance showing API details for Accounts page

What's included in this repo?

The frontend code is written with React and Tailwind CSS. The backend is using expressjs. This code takes the data from the server and displays it in a user friendly manner.

Getting started

Initially you will run the code hitting mocked data. This is because you need extra authentication information for hitting our actual APIs which is explained below.

cd app/client
yarn install
yarn start

If you see an error like this:

Proxy error: Could not proxy request /api/tsapi/v1/participants from localhost:3000 to http://localhost:8081.
See https://nodejs.org/api/errors.html#errors_common_system_errors for more information (ECONNREFUSED).

You can ignore it as this is because our server is not running. (See Hitting J.P. Morgan APIs locally section)

When looking at the code we recommend looking at the pages files within the src folder, we have 3 core pages; accounts, payments and service status. Each page refers to a set of APIs (account services, sending a payment and gathering service status updates). Within client and server folders we have readme with more details on each section.

Hitting J.P. Morgan APIs

This will require you to provide some SSL certificates. You will need to onboard to J.P. Morgan to access this information. Further details are available here.

Once you have the correct files ready you can upload them to your server (DO NOT COMMIT THESE FILES TO YOUR CODEBASE).

Hitting J.P. Morgan APIs locally

  1. Store your certs in a folder that is included in .gitignore (eg. certs)
  2. Open server/app.js and check below lines relate to where your certs are
// const httpsOpts = {
//   KEY: fs.readFileSync('../certs/jpmc.key', 'utf-8'),
//   CERT: fs.readFileSync('../certs/jpmc.crt', 'utf-8'),
// };
  1. Make sure paths on these lines match your folder
  2. Then run:
cd app/server
yarn install
yarn start:local

Testing

We are using cypress to test our screens.

cd app/client
npx cypress open

Contributing

We welcome any contributions you have. Steps for contribution are:

  1. If this is your first time contributing to JPMC codebases you will need to fill out our Contribution Licence Agreement (CLA). More information can be found at: https://github.com/jpmorganchase/.github/blob/main/CONTRIBUTING.md
  2. Write your code and create a PR and we will review it
  3. Your code will then be reviewed and merged if no issues are found.
  4. As this project is a submodule of the JPMC Payments you will need to update the commit ID reference there. You can follow their contribution guide for more information.