> ## Documentation Index
> Fetch the complete documentation index at: https://betterdatainc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install @commercegateway/commerce-gateway in your project

## Prerequisites

* **Node.js**: version 18 or higher
* **Package Manager**: npm, pnpm, or yarn
* **TypeScript**: version 5.0 or higher recommended

## Install Package

Run the following command in your terminal to install the core gateway package:

<CodeGroup>
  ```bash npm theme={null}
  npm install @commercegateway/commerce-gateway
  ```

  ```bash pnpm theme={null}
  pnpm add @commercegateway/commerce-gateway
  ```

  ```bash yarn theme={null}
  yarn add @commercegateway/commerce-gateway
  ```
</CodeGroup>

## Dependencies

The core package is designed to be lightweight with minimal dependencies. However, depending on the adapters and backends you use, you may need additional packages:

### For Redis Sessions

If you plan to use Redis for session management:

```bash theme={null}
npm install ioredis
```

### For Shopify Backend

If you use the built-in Shopify backend:

```bash theme={null}
npm install @shopify/shopify-api
```

### For Hono Server

If you want to use the Hono-based HTTP adapter:

```bash theme={null}
npm install hono @hono/node-server
```

## TypeScript Configuration

Ensure your `tsconfig.json` has `esModuleInterop` and `skipLibCheck` set to `true`:

```json tsconfig.json theme={null}
{
  "compilerOptions": {
    "target": "ESNext",
    "module": "ESNext",
    "moduleResolution": "node",
    "esModuleInterop": true,
    "skipLibCheck": true,
    "strict": true
  }
}
```

## Next Steps

Now that you've installed the package, follow the [Quickstart](/getting-started/quickstart) to build your first conversational commerce gateway.
