thePR0M3TH3AN/VoxVera
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/VoxVera.git synced 2025-09-07 14:38:42 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
0a85abb69dbd4b7cb24b5acf686866324cfbd266
VoxVera/README.md
thePR0M3TH3AN 0a85abb69d Fix README merge artifact and add quick steps
2025-06-17 19:13:34 -04:00

1.5 KiB
Raw Blame History

VoxVera Flyers

VoxVera provides scripts and templates for producing printable flyers with QR codes. These flyers link to content hosted through Tor and can also include a Nostr page. The project automates building the HTML, generating the QR codes, and copying all assets into a directory under host/ so they can be served statically.

Prerequisites

  • Node.js and npm
  • jq
  • qrencode
  • ImageMagick (convert)
  • javascript-obfuscator and html-minifier-terser (installed via npm)
  • pdftotext (optional, used when extracting fields from a PDF form)

Generating a Flyer

Run the helper script from the repository root:

# interactive prompts
./src/create_flyer.sh

# use answers from an existing PDF form
./src/create_flyer.sh --from-pdf path/to/form.pdf

The script updates src/config.json, regenerates QR codes, obfuscates index-master.html and nostr-master.html, and copies the resulting files plus PDFs and QR images into host/<subdomain>. The contents in that directory can then be hosted.

Additional documentation is available in the src/ directory; see src/README.md for more details on the obfuscation scripts and additional usage notes.

Step-by-Step

  1. Edit src/index-master.html or src/nostr-master.html if you need custom content.
  2. Run ./src/create_flyer.sh and follow the prompts, or use ./src/create_flyer.sh --from-pdf path/to/form.pdf.
  3. Host the generated host/<subdomain> directory. This project is licensed under the MIT License.