https://github.com/tooniez/st-container
🛳️ Containerized Streamlit app with Docker and Docker Compose
https://github.com/tooniez/st-container
docker docker-compose python streamlit
Last synced: 3 months ago
JSON representation
🛳️ Containerized Streamlit app with Docker and Docker Compose
- Host: GitHub
- URL: https://github.com/tooniez/st-container
- Owner: tooniez
- License: mit
- Created: 2024-10-20T03:07:33.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-21T13:26:30.000Z (over 1 year ago)
- Last Synced: 2025-02-10T21:44:06.905Z (over 1 year ago)
- Topics: docker, docker-compose, python, streamlit
- Language: Python
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
- Governance: .github/GOVERNANCE.md
Awesome Lists containing this project
README
Streamlit Container App 🐳📊
Containerized Streamlit app with Docker and Docker Compose
## Contents
1. [Introduction](#introduction)
2. [Prerequisites](#prerequisites)
3. [Available Commands](#available-commands)
4. [Usage](#usage)
5. [Docker Compose Configuration](#docker-compose-configuration)
6. [Customization](#customization)
7. [Contributing](#contributing)
8. [License](#license)
## Introduction
This project uses Docker and Docker Compose to manage the development and deployment process of a containerized Streamlit app. The Makefile provides convenient commands to manage the Docker container.
## Pages
- Home
- Data Generation
- EDA
- Playground
- Download
## Prerequisites
- Docker
- Docker Compose
- Make
## Quick Start
1. Run the hosted gh image `docker run -d -p 8501:8501 ghcr.io/tooniez/streamlit-container-app:latest`
2. Open the app in the browser `http://localhost:8501`
## Available Commands
The following commands are available through the Makefile:
### `make all`
This is the default command that runs the following sequence:
1. Stops the existing container
2. Rebuilds the Docker image
3. Runs the rebuilt container
### `make stop`
Stops and removes the Docker container.
### `make build`
Rebuilds the Docker image without using cache.
### `make run`
Runs the rebuilt Docker container in detached mode.
### `make remove`
Removes the Docker image.
## Usage
To use these commands, simply run `make all` followed by the command name. For example:
This will execute the default sequence of stopping the container, rebuilding the image, and running the rebuilt container.
## Docker Compose Configuration
The project uses a Docker Compose configuration file (`docker-compose.yml`) to define the service. The main service is named `st-container`.
## Customization
You can modify the Makefile to add more commands or adjust the existing ones according to your project needs.
## Contributing
If you want to contribute to this project, please make sure to follow the existing code style and submit a pull request with your changes.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.