# Quick start

### Prerequisites

Before you begin, ensure you have the following installed on your machine:

* [Git](https://git-scm.com/)
* Docker
* Docker Compose

### Step-by-Step Guide

#### 1. Clone the Repository

First, clone the Crypitor repository from GitHub.

```bash
git clone https://github.com/crypitor/blockchain-webhook
```

#### 2. Navigate to the Docker Directory

Change your directory to the `app/docker` folder within the cloned repository.

```
cd blockchain-webhook/app/docker
```

#### 3. Update Environment Variables

Copy the sample environment file `.env.sample` to `.env` and update it with your specific configuration.

```bash
cp .env.sample .env
```

Open the `.env` file in your preferred text editor and update the necessary variables. This file contains configuration settings that are crucial for running the application.

```toml
# update your ETH_PROVIDER_URL
ETH_PROVIDER_URL=https://mainnet.infura.io/v3/yourkey
```

#### 4. Start the Application

Use Docker Compose to build and start the application.

```bash
docker compose up -d
```

This command will start the Docker images (if not already built), create the necessary containers, and start the services in detached mode.

### Accessing the Application

Once the application is running, you can access it via the URL specified in your `.env` file. Typically, it will be accessible at `http://localhost:3000/` .

Access swagger document via `http://localhost:3000/docs`with `admin` and `crypitor@2024`