interaction-framework-gui Docs

Backend Setup

1. Move to backend folder using `cd server`

2. Create a .env file in server root directory `touch .env`

3. Paste the following content in .env file and replace the username & password with your local mysql instance creditnials

PORT=3001
DB_LOCAL_URI=mysql://username:password@localhost:3306/transaction_framework

Note: prefer not to change port number in above file

4. Install all required dependencies using `npm i` or `npm install`

5. Run tests using `npm test`

6. Start the server using `npm run` & keep the server up.

Frontend Setup

1. Move to back to project Home directory

2. Move to frontend folder using `cd client`

3. Install all required dependencies using `npm i` or `npm install`

4. Start the server using `npm run`

Data flow diagram components

In the above Image we can see the following components:

Voilet Node represents a single master interaction node
Green Nodes represents interaction in data flow
Balck Nodes represents parameters of an interaction
Blue Node represents response of an interaction
Grey Paths/Edge represents relation between interaction and it's parameter
Green Animated Paths/Edge represents relationship and flow of data between interaction and it's responses and vice-versa
Yellow Animated Paths/Edge represents relationship and flow of data between interaction and it's responses and vice-versa