Installation

.exe Installation (recommended)

1. Install the .exe file here.

2. Unzip the downloaded file.

3. Run the .exe file.

4. Give the .exe file network access.

   
5. Go to http://localhost:8501/ to access the app.

   
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

Ensure you have Docker Desktop installed in your system.

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

   

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.

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