# Installation

## .exe Installation (recommended)

1. Install the .exe file [here](https://drive.google.com/file/d/1zDS6xK3oOeq9rELP7JFryzbS0SPEPYco/view?usp=drive_link).
2. Unzip the downloaded file.
3. Run the .exe file.
4. Give the .exe file network access.

   <div align="left"><figure><img src="https://2239543504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCS6G2csctKdHyCr37a82%2Fuploads%2Fvm3d5XSZrenD0AzBZMrJ%2Fimage.png?alt=media&#x26;token=ffb88da5-3960-4720-9c98-e20b486218f2" alt=""><figcaption></figcaption></figure></div>
5. Go to <http://localhost:8501/> to access the app.

   <div align="left"><figure><img src="https://2239543504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCS6G2csctKdHyCr37a82%2Fuploads%2FPSHDmdXcJkUlQgiyNaXA%2Fimage.png?alt=media&#x26;token=ea04cd84-afa7-42fd-9117-d08a06e35b53" alt=""><figcaption></figcaption></figure></div>
6. Simply close the .exe file to stop running the app.

### Where is settings.yaml and trades.ddb created?

The `settings.yaml` and `trades.ddb` will be created and read in the same directory as the .exe file.

```
.
├── paperpaws.exe
├── README.txt
├── settings.yaml <-
└── trades.ddb <-
```

## Docker Installation

{% hint style="info" %}
Ensure you have Docker Desktop installed in your system.
{% endhint %}

### Simple

1. Open command prompt
2. Pull the Docker image\
   `docker pull paperpaws/paper-paws-poc:1.0.0`
3. Run the Docker image\
   `docker run --name paper-paws-app -p 8501:8501 paperpaws/paper-paws-poc:1.0.0`
4. Go to <http://localhost:8501/> to access the app

   <div align="left"><figure><img src="https://2239543504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCS6G2csctKdHyCr37a82%2Fuploads%2FKNFpylTGfnxtR6k1sKF3%2Fimage.png?alt=media&#x26;token=0ff3c067-7f6d-4f8d-8ca2-8538e975f7b5" alt=""><figcaption></figcaption></figure></div>

### Advanced

1. Clone the repository\
   `git clone https://github.com/5zyyy/paper-paws-poc.git`
2. Build the Docker image\
   `docker build -t paper-paws-poc:1.0.0 .`
3. Run Docker image (create container)\
   `docker run --name paper-paws-app -p 8501:8501 paper-paws-poc:1.0.0`
4. Go to <http://localhost:8501/> to access the app
5. Save Docker image as .tar (optional)\
   `docker save -o paper-paws-poc.tar paper-paws-poc:1.0.0`

### Reopening and closing the app

To run or stop the app from running, simply open Docker Desktop, navigate to containers and run/stop the app.

<figure><img src="https://2239543504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCS6G2csctKdHyCr37a82%2Fuploads%2F2JCBa8JMcdkmBfcmRnet%2Fimage.png?alt=media&#x26;token=8e0c2895-f6a5-4404-9420-193a164496a0" alt=""><figcaption></figcaption></figure>

<figure><img src="https://2239543504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCS6G2csctKdHyCr37a82%2Fuploads%2FKkdOtyUHTjbjQ05lcJ4x%2Fimage.png?alt=media&#x26;token=f359fb98-9c79-49b6-a428-04779d2c3fb1" alt=""><figcaption></figcaption></figure>

<figure><img src="https://2239543504-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCS6G2csctKdHyCr37a82%2Fuploads%2FzlcNGKr0VhdQL612WC6A%2Fimage.png?alt=media&#x26;token=e6011f78-6829-4429-8233-a974240d1d92" alt=""><figcaption></figcaption></figure>

## Clone from Github Repository

1. Clone the repository\
   `git clone https://github.com/5zyyy/paper-paws-poc.git`
2. Install dependencies\
   `pip install -e .`\
   `pip install -r requirements.txt`
3. Run the app\
   `streamlit run .\src\app.py`
4. Compile .exe file (optional)\
   `python build.py`