diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..9ab02ee --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,6 @@ +services: + cliffbot: + container_name: Cliffbot + image: git.breadone.xyz/breadone/cliffbot:v1 + ports: + - 1234:80 \ No newline at end of file diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..40b3f14 --- /dev/null +++ b/readme.md @@ -0,0 +1,20 @@ +# Cliffbot2 + +Just a simple lil web scraper for the Heathcliff webcomic. An improved verison of [a similar project](https://git.breadone/xyz/breadone/cliffbot) I made a few years ago, this time without requiring AWS Lambda, and all nice and dockerised. + +## Setup + +Docker is recommended: + +Clone the repo (or just download the compose file), then run: + +```bash +docker compose up -d +``` + +Or if you just want to run the python file, + +1. clone the repo +2. create and activate a virtualenv: `virtualenv .venv; source .venv/bin/activate` +3. install the requirements: `pip install -r requirements.txt` +4. run the app: `fastapi run main.py`