> For the complete documentation index, see [llms.txt](https://docs.openg2p.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openg2p.org/products/g2p-bridge/development/developer-install/example-bank.md).
# Example Bank
Developers can set up and run the G2P Bridge Example Bank Simulator on their local machines. This guide outlines the steps to install the same on a **Linux-based** laptop or desktop.
## Prerequisites
* Python3
* Git
* PostgreSQL
* Redis
* Celery
## Installation of Example Bank Simulator
#### 1. Update system packages
* Log in to your Linux server using SSH and update the package list and upgrade the existing packages:
```bash
sudo apt update
sudo apt upgrade -y
```
#### 2. Install dependencies
```bash
sudo apt install -y python3-pip python3-dev build-essential
```
3\. Install and configure PostgreSQL
* G2P Bridge requires PostgreSQL as the database engine. Install PostgreSQL (if not already installed) and create a new database user for G2P Bridge.
```bash
sudo apt install -y postgresql
sudo su - postgres
CREATE ROLE bankuser WITH LOGIN NOSUPERUSER CREATEDB CREATEROLE INHERIT REPLICATION CONNECTION LIMIT -1 PASSWORD 'password';
CREATE DATABASE bankdb WITH OWNER = bankuser CONNECTION LIMIT = -1;
exit
```
4\. Clone the G2P Bridge Repository
* Clone the consolidated `g2p-bridge` monorepo to your local machine. The Example Bank now lives under its `example-bank/` folder.
```bash
git clone https://gitlab.com/openg2p/g2p-bridge/g2p-bridge
```
{% hint style="info" %}
The Example Bank Python packages are **not published to PyPI** — install them from local source (editable installs) out of the cloned repo, as shown below. Only `openg2p-fastapi-common` / `openg2p-fastapi-auth` come from PyPI.
{% endhint %}
#### 5. Install Python Libraries and G2P Bridge Components
{% tabs %}
{% tab title="Example Bank API" %}
**Setting up the Bridge API**
* Make a new Python virtual environment.
```bash
cd g2p-bridge/example-bank/openg2p-example-bank-api
python3 -m venv venv
```
* Activate the virtual environment.
```bash
source venv/bin/activate
```
* Use `pip` to install the required Python packages, including the core libraries for the G2P Bridge.
```bash
# External OpenG2P libs from PyPI
python3 -m pip install openg2p-fastapi-common openg2p-fastapi-auth
# In-repo packages from local source (editable)
python3 -m pip install -e ../openg2p-example-bank-models
python3 -m pip install -e .
```
* Create a .env file
```
EXAMPLE_BANK_DB_HOSTNAME='localhost'
EXAMPLE_BANK_DB_DBNAME='bankdb'
EXAMPLE_BANK_DB_USERNAME='bankuser'
EXAMPLE_BANK_DB_PASSWORD='password'
EXAMPLE_BANK_CELERY_BROKER_URL='redis://127.0.0.1:6379/0'
EXAMPLE_BANK_CELERY_BACKEND_URL='redis://127.0.0.1:6379/0'
```
* Migrate the database schema
```bash
python3 main.py migrate;
```
* Run the API server on `127.0.0.1:8000`
```bash
gunicorn "main:app" --workers 1 --worker-class uvicorn.workers.UvicornWorker --bind 127.0.0.1:8000
```
{% endtab %}
{% tab title="Example Bank Celery" %}
**Setting up the Example Bank Celery**
* Make a new Python virtual environment.
```bash
# Beat producer (use openg2p-example-bank-celery-workers for the worker)
cd g2p-bridge/example-bank/openg2p-example-bank-celery-beat-producers
python3 -m venv venv
```
* Activate the virtual environment.
```bash
source venv/bin/activate
```
* Use `pip` to install the required Python packages, including the core libraries for the G2P Bridge.
```bash
# External OpenG2P libs from PyPI
python3 -m pip install openg2p-fastapi-common openg2p-fastapi-auth
# In-repo packages from local source (editable)
python3 -m pip install -e ../openg2p-example-bank-models
python3 -m pip install -e .
```
* Run redis-server (if not already started)
```
sudo systemctl start redis
```
* Create a .env file
```
EXAMPLE_BANK_CELERY_DB_HOSTNAME='localhost'
EXAMPLE_BANK_CELERY_DB_DBNAME='bankdb'
EXAMPLE_BANK_CELERY_DB_USERNAME='bankuser'
EXAMPLE_BANK_CELERY_DB_PASSWORD='password'
EXAMPLE_BANK_CELERY_CELERY_BROKER_URL='redis://127.0.0.1:6379/0'
EXAMPLE_BANK_CELERY_CELERY_BACKEND_URL='redis://127.0.0.1:6379/0'
EXAMPLE_BANK_CELERY_MT940_STATEMENT_CALLBACK_URL='http://openg2p-g2p-bridge-api/upload_mt940'
```
* Run the celery beat and worker
```bash
celery -A main.celery_app worker --loglevel=info --beat & \
celery -A main.celery_app worker --loglevel=info -Q g2p_bridge_celery_worker_tasks
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.openg2p.org/products/g2p-bridge/development/developer-install/example-bank.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.