thePR0M3TH3AN/VoxVera
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/VoxVera.git synced 2025-09-09 15:38:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add Python CLI and update docs

Browse Source
This commit is contained in:
thePR0M3TH3AN
2025-06-18 22:27:28 -04:00
parent 9cbc9a2041
commit d7af591319
8 changed files with 219 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/README.md
View File

@@ -124,21 +124,21 @@ If you prefer to use Visual Studio Code to edit and run these scripts:
```
## Creating and Hosting a Flyer
The `create_flyer.sh` script automates filling `config.json`, building the HTML files, and copying everything into a new directory under `host/`.
The `voxvera` CLI automates filling `config.json`, building the HTML files, and copying everything into a new directory under `host/`.
### Usage
```bash
# interactive mode
./create_flyer.sh
voxvera init && voxvera build
# use an alternate config file
./create_flyer.sh -c path/to/custom.json
voxvera init --config path/to/custom.json && voxvera build --config path/to/custom.json
# use an existing filled PDF form
./create_flyer.sh --from-pdf path/to/form.pdf
voxvera init --from-pdf path/to/form.pdf && voxvera build
```
By default the script updates `src/config.json`. Use the `-c` option to specify a different file. After answering the prompts (or extracting from the PDF), `index.html` and `nostr.html` are generated and copied along with the QR code images and PDFs. The files end up in `host/<subdomain>` which can be served statically.
QR codes are built automatically during this process. After the configuration is updated, `create_flyer.sh` calls `generate_qr.sh` to read the URLs from `config.json` and produce `qrcode-content.png` and `qrcode-tear-offs.png`.
QR codes are built automatically during this process. After the configuration is updated, the CLI regenerates the QR codes by invoking `generate_qr.sh` to read the URLs from `config.json` and produce `qrcode-content.png` and `qrcode-tear-offs.png`.

2
src/import_from_json.sh
View File

@@ -17,5 +17,5 @@ for json in "${files[@]}"; do
subdomain=$(jq -r '.subdomain' "$json")
dest="host/$subdomain"
rm -rf "$dest"
./src/create_flyer.sh --no-interaction
voxvera build --config src/config.json
done