Skip to content

Commit

Permalink
📝 Add registration and authentication instructions for GUI client
Browse files Browse the repository at this point in the history
  • Loading branch information
Samuel Guillemet committed Feb 7, 2024
1 parent 5f8f676 commit 59668a5
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,13 @@ $> ./cli.sh project website-frontend build
$> ./cli.sh project website-frontend start
```

---
Before using the GUI client, you need to register clients and enables them using the website.

Go to http://localhost:3001/register and register any clients you want to use.

Then go to http://localhost:3001/account/users and authenticate using the admin account. You can now enable the clients you want to use and set them some money they can use to buy stocks.

---

You can now use the GUI client to interact with the broker.
Expand All @@ -147,3 +154,18 @@ $> cd clients/graphical-user-interface; poetry run python quickfix_client_gui/ru
```

In cas you need to change the ip of the quickfix server, you need to modify this file [clients/quickfix-client/broker_quickfix_client/constant.py](clients/quickfix-client/broker_quickfix_client/constant.py) withe `SERVER_IP` variable.


### Test the project

All the components are tested with unit tests and integration tests which you can launch using the cli script.

```shell
$> ./cli.sh project <component> test
```

### Metrics

The project is monitored with prometheus and grafana. You can access the grafana dashboard at http://localhost:3000 with anonymous access.

You will have dashboards for kafka cluster and the different components of the project.

0 comments on commit 59668a5

Please sign in to comment.