Skip to content

Commit

Permalink
info: update README to include instructions for building and running …
Browse files Browse the repository at this point in the history
…Docker locally
  • Loading branch information
amanovishnu committed Dec 31, 2024
1 parent 03fd5a4 commit eb43e17
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@

### Docker

##### Build and Run Locally

To create and run the Docker image:

1. Build the Docker image:
Expand All @@ -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

Expand All @@ -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.

Expand Down

0 comments on commit eb43e17

Please sign in to comment.