HPR/hpr_generator
5
0
Fork 0
Code Issues 33 Pull Requests 1 Actions Packages Projects Releases Wiki Activity
52a314f2a9
hpr_generator/README.md
Roan Horning 52a314f2a9
Add command line option all 
Use --all or -a when calling site-generator instead of special page
ALL to generate all the configured pages for a website.
2022-08-19 22:11:38 -04:00

2.4 KiB
Raw Blame History

hpr_generator

Static web page generator for the Hacker Public Radio website.

Installation

  • Clone or download this repository
  • Create the sqlite3 database from the files in the _sql directory. The default name for the database file is "hpr.db" and should be located in the root of the project directory. The name and location can be set in the site.cfg file.
  • Two sql helper scripts are available to generate an empty database or a database filled with test data.
    • For an empty database: cat Create_Database_Empty.sql | sqlite3 hpr.db
    • For a database with test data: cat Create_Database_Test.sql | sqlite3 hpr.db
  • SQLite v3.8.3 or greater is recommended. CTE WITH clauses are used in some template queries. Must convert WITH clauses to sub-queries when using earlier versions of SQLite.
  • Install the needed Perl modules using preferred method (distribution packages, CPAN, etc.)
    • GetOpt
    • Pod::Usage
    • Config::Std
    • Template
    • Template::Plugin::File
    • Template::Plugin::DBI
    • DBI
    • Tie::DBI
    • DBD::SQLite
    • Date::Calc

Usage

Generate two specific pages: site-generator index about

Generate the whole site: site-generator --all

Generate pages based on the same template: site-generator correspondent=1,3,5..10

Support

Please submit an Issue, and add the label "Help Request" for help running or installing the site-generator.

For discussing HPR site generation in general, please submit an Issue and add the label "General Discussion".

Contributing

Happy to take any contributions or suggestions.

To contribute code or documentation, please create a fork of the project and submit a pull request or send a patch. If an issue exists that is related to your patch, please assign the issue to yourself, or if it is already assigned to someone else, please coordinate with them to minimize duplicated efforts.

If you have found an error in the code or the generated HTML, please submit an Issue, and add the label "Bug Found".

To make a suggestion, please submit an Issue, and add the label "Feature Request".

Authors and acknowledgment

  • Roan "Rho`n" Horning