Skip to content

Commit a83fb1b

Browse files
committed
Update README.md
1 parent dcc5ed6 commit a83fb1b

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,31 @@
11
## Silly comments
22

3-
Comment system for your website
4-
Using *flask* and *htmx* to create and serve comments.
3+
Webpage comment system, built on *Flask* and *HTMX*. Silly simple, bare
4+
bones, minimal... well except it's Python.
55

66
Why silly? Because this implementation is as naive as I could make it.
77
Comments are just files. I use [ULID](https://github.com/ulid/spec)
88
for the comments' file names (they're unique and encode the creation
99
timestamp).
1010

1111
I want this application to be simple enough that anyone can start it,
12-
without asking for a Docker image. Low bar, I know.
12+
without needing a Docker image. Low bar, I know.
13+
14+
If you want to host it on your VPS, you can use the `silly_app.conf`
15+
file as a start for your NGINX configuration.
16+
17+
You can start it with:
1318

1419
```sh
1520
python3 -m venv my_venv
1621
source my_venv/bin/activate
1722
python3 -m pip install -r requirements.txt
1823
./cmd.sh run
1924
```
25+
26+
Or go with the [uv](https://docs.astral.sh/uv/):
27+
28+
```sh
29+
uv sync
30+
uv run flask --app sillysimple.py -p 32168
31+
```

0 commit comments

Comments
 (0)