> For the complete documentation index, see [llms.txt](https://jiffyjrdevelopment.gitbook.io/jiffyjrdevelopmentdocs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jiffyjrdevelopment.gitbook.io/jiffyjrdevelopmentdocs/jiffy-jr-development-docs/jiffy-banking-v1/installation.md).

# Installation

## Requirements

| Dependency                 | Required    | Notes                                                       |
| -------------------------- | ----------- | ----------------------------------------------------------- |
| `oxmysql`                  | ✅ Yes       | Database bridge                                             |
| `qb-core`                  | Framework   | When `Config.Framework = 'qb'`                              |
| `qbx_core`                 | Framework   | When `Config.Framework = 'qbox'`                            |
| `es_extended`              | Framework   | When `Config.Framework = 'esx'`                             |
| `ox_target` or `qb-target` | Recommended | Proximity-prompt fallback included                          |
| `ox_lib`                   | Optional    | Set `Config.RequireOxLib = false` to make it truly optional |

{% hint style="warning" %}
Only **one** of the three framework resources is required. You do not need all three.
{% endhint %}

***

## Steps

{% stepper %}
{% step %}

### Add the Resource

Drop the `jiffy-banking` folder into your resources directory. Category folders are fine:

```
resources/
  [JiffyJrDev]/
    jiffy-banking/
```

{% endstep %}

{% step %}

### Update server.cfg

```
ensure jiffy-banking
```

{% hint style="danger" %}
`jiffy-banking` must start **after** your framework resource (`qb-core`, `qbx_core`, or `es_extended`) and **after** `oxmysql`. If it starts before them, you will get a startup error.
{% endhint %}
{% endstep %}

{% step %}

### Register the Bank Card Item

Before going live, register the `banking_card` item in your framework's item system. See the [Item Registration](/jiffyjrdevelopmentdocs/jiffy-jr-development-docs/jiffy-banking-v1/item-registration.md) page for your framework.
{% endstep %}

{% step %}

### Set Your Framework

Open `shared/config.lua` and set:

```lua
Config.Framework = 'qb'   -- 'qb' | 'qbox' | 'esx'
```

{% endstep %}

{% step %}

### Auto-Install

By default, `Config.AutoInstall = true` will create all required database tables on the first start. You should see a confirmation in the server console.

{% hint style="success" %}
If tables already exist from a previous install, `AutoInstall` will never drop or alter existing data — it only adds missing tables.
{% endhint %}
{% endstep %}

{% step %}

### Remove Conflicting Resources

If you are replacing any of the following, **stop them before starting jiffy-banking**:

* `qb-banking` / `qs-banking`
* `okokBilling`
* `qb-management` *(society money handling)*

You do not need to delete them — just remove their `ensure` lines. jiffy-banking includes a compatibility layer that handles scripts calling their export patterns.
{% endstep %}
{% endstepper %}

***

## Verifying the Install

Restart the resource and check the server console. A successful start looks like:

```
[jiffy-banking] Framework bridge: QBCore
[jiffy-banking] AutoInstall: all tables OK
[jiffy-banking] jiffy-banking v1.0.0 started.
```