Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fadado/jqt

jqt · The jq template engine
https://github.com/fadado/jqt

gpp jq pandoc templates

Last synced: 3 months ago
JSON representation

jqt · The jq template engine

Awesome Lists containing this project

README 

        
# _jqt_ · The _jq_ template engine



_jqt_ is a web template engine that uses [_jq_](https://stedolan.github.io/jq/) as expression language.



The tools used in the implementation of _jqt_ are:



* [jq](https://stedolan.github.io/jq/), a lightweight and flexible command-line JSON processor.

* [GPP](https://logological.org/gpp), a general-purpose preprocessor.

* [Pandoc](http://pandoc.org/), a universal document converter.

* [Bash](https://www.gnu.org/software/bash/), [sed](https://www.gnu.org/software/sed/) and other shell tools.



If you want to learn how to use _jqt_ visit the site 

. The site pages are generated using _jqt_ in

the [`docs`](./docs/) folder of this repository.

If you are interested in _jqt_ you can see also [JBOL](https://github.com/fadado/jbol),

a related project with a collection of modules for the _jq_ language.



_jqt_ is developed under the _Fedora_ Linux distribution, and a lot of

portability issues are expected at this stage of development. Please, use this

GitHub repository features if you want to send any kind of questions.



## Project management



This project uses [GNU Make](https://www.gnu.org/software/make/) on several

development activities, but `make` is not necessary to run `jqt`. This section explains

the repository structure and how it is managed.



### Makefile



The file `Makefile` concentrates all the routine procedures, like running the tests

or install last versions of scripts in the system directories. The main defined _targets_

are:



* `list`:  list all targets defined in the Makefile.



* `check`: run the _jqt_ tests. This is the default target.



* `clean`: remove all files generated during tests execution.



* `install`: install _jqt_ scripts and related files in the system directories.



* `uninstall`: remove installed files from the system directories.



### Installation



In systems with the GNU software installed tools such as [Bash](https://www.gnu.org/software/bash/),

[sed](https://www.gnu.org/software/sed/) and other shell tools are installed by default.

To use _jqt_ you must install additional tools like [GPP](https://logological.org/gpp)

or [Pandoc](http://pandoc.org/); for example, in recent _Fedora Linux_ distributions

the following command will install all the extra software _jqt_ needs:



```zsh

$ sudo dnf -y install make general-purpose-preprocessor jq pandoc python2-pyyaml

```



To install _jqt_ simply run `make install` on the _jqt_ repository top

directory. If you don’t like to install into the `/usr/local` system directory you

can change the destination directory:



```zsh

$ sudo make install prefix=/your/installation/path

```



Alternatively you can install _jqt_ manually executing a few commands on the

_jqt_ top directory:



```zsh

$ sudo mkdir -p /usr/local/bin /usr/local/share/jqt

$ sudo cp bin/* /usr/local/bin

$ sudo cp -r share/* /usr/local/share/jqt

$ [[ $PATH =~ /usr/local/bin ]] || echo 'Add /usr/local/bin to your PATH'

```



### Scripts



The `bin` directory contains `jqt` and other related tools. The `jqt` script

also needs some files located in the [`share`](./share/) directory.



### Tests



The execution of `make check` or simply `make` will run several tests located in the directory

[`tests`](./tests/). Ensure that the tests are passed before start

another `jqt` uses.



### Documentation



The directory [`docs`](./docs/) contains the source files for _jqt_

documentation.  Please see the directory [`docs`](./docs/) for all information

on this subproject.