# 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`


---

# Agent Instructions: 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:

```
GET https://docs.crypitor.com/crypitor-service/self-hosted/quick-start.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.