Prez UI | Prez Docs

Prez UI is the front end of Prez - a linked data API - and is a suite of packages to interact with and render RDF in JavaScript.

Screenshot of a catalogue in Prez UI

Running Prez UI

There are several ways to use Prez UI's suite of features. The most common way to run Prez UI is by creating a 'themed' instance using create-prez-app. You can do so by running:

npx create-prez-app@latest <project_name>

(Note: for pnpm, run pnpm dlx instead of npx)

See the included README in the starter template from the above command, or the theming documentation for more information on how to get started.

Important

If you're upgrading your Prez UI theme from < v4.2.0 to v4.2.0+, you will need to follow the upgrade guide to upgrade to Nuxt v4 & Tailwind v4, which is a breaking change.

Note

For v4.0.0 only, a few small changes need to be made to the starter template to be able to run your theme

the prez-ui dependency version should be set to ^4.0.0 before installing
if you're enabling the SPARQL page, copy the sparql.vue page from the prez-ui source code into your template and install @triply/yasgui

For other use cases, see the below packages that are available.

Packages

Prez UI is comprised of 4 NPM packages:

prez-lib: the JavaScript library containing RDF processing logic
prez-components: the Vue.js component library
prez-ui: the base layer Nuxt application
create-prez-app: the NPX starter template for initialising a Prez UI theme

How do I decide what to use?

License

This version of Prez UI and the contents of this repository are also available under the BSD-3-Clause License.