From 1231e9e90dd84e3641a316ee385af466663e5d14 Mon Sep 17 00:00:00 2001 From: Ayo Date: Fri, 8 May 2026 09:26:02 +0200 Subject: [PATCH] chore: add uptime status badge to readme --- README.md | 66 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 35 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index b4e4d2f..3ce823e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,17 @@ # Threads +![Uptime](https://up.ayo.run/api/badge/16/status) + Show off your favorite public threads and offer hand-picked, fine-grained, topical subscriptions! These are streams of thought you decide to float to your personal site for being a bit more-effort than other small posts, but still yet to be refined as a blog. How it works: + 1. a featured status will be fetched on the server along with qualified "descendants", which are replies of the same author in a single thread. 2. clean HTML with some styling will be sent to the viewer's browser 3. bit of client-side JS for progressive enhancement: - 1. `` by GitHub: https://github.com/github/relative-time-element + 1. `` by GitHub: https://github.com/github/relative-time-element 4. self-hostable with the app configuration in `config.json` file -- we are working on a docker way and easy configuration See it [in action](https://ayco.io/threads). @@ -19,54 +22,55 @@ See it [in action](https://ayco.io/threads). 1. Set up your **Debian** (for other environments, search for counterpart instructions) - ```bash - # update repositories - $ sudo apt update + ```bash + # update repositories + $ sudo apt update - # install python stuff - $ sudo apt install python3-pip python3-dev build-essential libssl-dev libffi-dev python3-setuptools python3-venv - ``` + # install python stuff + $ sudo apt install python3-pip python3-dev build-essential libssl-dev libffi-dev python3-setuptools python3-venv + ``` > For MacOS: https://docs.python.org/3/using/mac.html 2. Install dependencies and set up the project - ```bash - # clone the project - $ git clone git@git.sr.ht:~ayoayco/threads + ```bash + # clone the project + $ git clone git@git.sr.ht:~ayoayco/threads - # go into the project directory - $ cd threads + # go into the project directory + $ cd threads - # create app config from example - $ cp example_config.json config.json + # create app config from example + $ cp example_config.json config.json - # create python environment: - $ python3 -m venv .venv + # create python environment: + $ python3 -m venv .venv - # activate python env: - $ . .venv/bin/activate + # activate python env: + $ . .venv/bin/activate - # install dependencies - (.venv)$ python -m pip install -r requirements.txt + # install dependencies + (.venv)$ python -m pip install -r requirements.txt - # create configuration from example config file - (.venv)$ cp ./example_config.json ./config.json + # create configuration from example config file + (.venv)$ cp ./example_config.json ./config.json - # rejoice! - ``` + # rejoice! + ``` 3. To start development, run the following: - ```bash - (.venv)$ flask --debug run - ``` - > Note: On a Mac, the default port 5000 is used by AirDrop & Handoff; you may have to turn those off + ```bash + (.venv)$ flask --debug run + ``` + + > Note: On a Mac, the default port 5000 is used by AirDrop & Handoff; you may have to turn those off 4. After development session, deactivate the python env - ```bash - (.venv)$ deactivate - ``` + ```bash + (.venv)$ deactivate + ``` ## Deployment