mirror of
https://github.com/PR0M3TH3AN/VoxVera.git
synced 2025-09-08 06:58:42 +00:00
64 lines
2.3 KiB
Markdown
64 lines
2.3 KiB
Markdown
# 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)
|
|
|
|
## Installing Dependencies
|
|
|
|
On Debian or Ubuntu systems you can install the required packages with:
|
|
|
|
```bash
|
|
sudo apt update
|
|
sudo apt install -y jq qrencode imagemagick poppler-utils nodejs npm
|
|
```
|
|
|
|
### macOS
|
|
|
|
With [Homebrew](https://brew.sh) you can install the same dependencies:
|
|
|
|
```bash
|
|
brew install jq qrencode imagemagick poppler node coreutils
|
|
```
|
|
|
|
These scripts rely on the GNU implementation of `mktemp` (`gmktemp`) found in
|
|
`coreutils`. If you prefer not to install `coreutils`, edit the scripts to use
|
|
`mktemp` without the `--suffix` option.
|
|
|
|
The obfuscation scripts also rely on a pair of Node modules. Install them
|
|
globally:
|
|
|
|
```bash
|
|
npm install -g javascript-obfuscator html-minifier-terser
|
|
```
|
|
|
|
A helper script `setup.sh` is provided to check for these dependencies and
|
|
install anything that is missing.
|
|
|
|
## Generating a Flyer
|
|
Run the helper script from the repository root:
|
|
|
|
```bash
|
|
# 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](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](./LICENSE).
|