add compose file that hopefully works and readme

This commit is contained in:
June 2025-10-16 21:16:01 +13:00
parent ecbefc9608
commit 61a177d1c4
2 changed files with 26 additions and 0 deletions

6
docker-compose.yml Normal file
View File

@ -0,0 +1,6 @@
services:
cliffbot:
container_name: Cliffbot
image: git.breadone.xyz/breadone/cliffbot:v1
ports:
- 1234:80

20
readme.md Normal file
View File

@ -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`