Skip to content

Commit

Permalink
Add db controls and Quick Start Guide (#9)
Browse files Browse the repository at this point in the history
* Added feature to clear and restore db

* Added Dashboard image

* Added Quick Start guide
  • Loading branch information
devinpearson authored Jun 8, 2024
1 parent 4b35bd3 commit e17932e
Show file tree
Hide file tree
Showing 17 changed files with 802 additions and 423 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
## Installation

# Investec Programmable Banking Open API Simulator
# Investec Programmable Banking Stateful Sandbox

A nodejs server to get eveyone building and demoing regardless whether you have an account.

![GitHub](https://img.shields.io/github/license/devinpearson/programmable-banking-sim)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=round-square)](https://github.com/devinpearson/programmable-banking-sim/pulls)

![Dashboard view](/images/dashboard.png)

### Installation
Before installing, [download and install Node.js](https://nodejs.org/en/download/).

Expand All @@ -28,8 +30,15 @@ npm run dev

This will start the simulator on http://localhost:3000

Accessing the room of the domain will show the dashboard view of the server. The dashboard allows you to set the environment variables for the server and view the logs of the server.

There are helpful links to the Investec docs, Community wiki, Github repo and the Postman collection.

Supported endpoints

Dashboard
- / - Dashboard view

Auth
- /identity/v2/oauth2/token

Expand All @@ -49,7 +58,4 @@ Mock API only endpoints
- POST /za/pb/v1/accounts - Create a new account
- DELETE /za/pb/v1/accounts/:accountId - Deletes the account and its transactions

Programmable documentation can be found here: https://developer.investec.com/programmable-banking/


https://sqlitebrowser.org/
Programmable documentation can be found here: https://developer.investec.com/programmable-banking/
Binary file added images/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 17 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "programmable-banking-sim",
"version": "1.0.0",
"version": "1.1.0",
"description": "Local Simulation of the api service. for local testing and demo purposes",
"main": "src/index.js",
"type": "module",
Expand All @@ -18,6 +18,7 @@
"license": "MIT",
"dependencies": {
"@prisma/client": "^5.13.0",
"@tailwindcss/aspect-ratio": "^0.4.2",
"@tailwindcss/forms": "^0.5.7",
"@types/express": "^4.17.21",
"@types/node": "^20.12.7",
Expand Down
Binary file added public/1_postman_link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/2_postman_env.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/3_postman_env_select.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/4_postman_env_update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/5_postman_sim_update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/6_postman_accounts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/7_postman_account_data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit e17932e

Please sign in to comment.