From eb43e17527a9f1e7f28ccd35007c991a6ee641a8 Mon Sep 17 00:00:00 2001 From: amanovishnu Date: Tue, 31 Dec 2024 09:06:01 +0530 Subject: [PATCH] info: update README to include instructions for building and running Docker locally --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 569b012..cca5b29 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,8 @@ ### Docker +##### Build and Run Locally + To create and run the Docker image: 1. Build the Docker image: @@ -79,6 +81,21 @@ To create and run the Docker image: 3. Open your browser and navigate to **`http://localhost:8501`**. +##### Run with Pre-Built Image + +A pre-built Docker image is available on Docker Hub: + +1. Pull the Docker image: + ```sh + docker pull amanovishnu/outreach-composer-for-job-search:latest + ``` + +2. Run the Docker container: + ```sh + docker run -p 8501:8501 amanovishnu/outreach-composer-for-job-search:latest + ``` + +3. Open **`http://localhost:8501`** in your browser to use the Streamlit application. ### File Structure @@ -97,6 +114,21 @@ To create and run the Docker image: - **`requirements.txt`** : List of Python dependencies - **`setup.cfg`** : Configuration for flake8 and mypy +├── Dockerfile +├── LICENSE +├── README.md +├── app.py +├── chains.py +├── notebook +│ ├── my_portfolio.csv +│ └── notebook.ipynb +├── portfolio.py +├── requirements.txt +├── setup.cfg +├── utils.py + + + ### License This project is licensed under the MIT License. See the **LICENSE** file for details.