Skip to content

Commit b3f2ede

Browse files
committed
add docker support
1 parent f76b2a3 commit b3f2ede

File tree

2 files changed

+15
-5
lines changed

2 files changed

+15
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,24 @@ TVWB uses [Flask](https://flask.palletsprojects.com/en/2.2.x/) to handle the web
2727

2828
# Quickstart 📘
2929

30-
If you an experienced Python developer, you can skip the Installation and Serving the app Sections.
31-
They cover installing with pip and serving a flask app.
30+
### Installation
3231

33-
* [Installation](https://github.com/robswc/tradingview-webhooks-bot/wiki/Installation)
34-
* [Serving the App](https://github.com/robswc/tradingview-webhooks-bot/wiki/Hosting)
32+
* [Docker](https://github.com/robswc/tradingview-webhooks-bot/wiki/Docker) (recommended)
33+
* [Manual](https://github.com/robswc/tradingview-webhooks-bot/wiki/Installation)
3534

35+
### Hosting
3636

37-
**Ensure you're in the `src` directory.**
37+
* [Deploying](https://github.com/robswc/tradingview-webhooks-bot/wiki/Hosting)
38+
* [Cloud](https://github.com/robswc/tradingview-webhooks-bot/wiki/Hosting#cloud-hosting) (recommended)
39+
* [Local](https://github.com/robswc/tradingview-webhooks-bot/wiki/Hosting#using-a-personal-pc)
3840

41+
42+
---
43+
Ensure you're in the `src` directory. When running the following commands, **if you installed manually**.
44+
**If you used docker**,
45+
start the tvwb.py shell with `docker-compose run app shell` (in the project root directory) and omit the `python3 tvwb.py` portion of the commands.
46+
47+
---
3948
### Creating an action
4049

4150
```bash

docker-compose.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ services:
55
dockerfile: Dockerfile
66
volumes:
77
- ./src/components:/app/components
8+
- ./src/settings.py:/app/settings.py
89
ports:
910
- "5000:5000"
1011
network_mode: 'host'

0 commit comments

Comments
 (0)