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.
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
For v4.0.0, a few small changes need to be made to the starter template until we release a new version:
- the
prez-ui
dependency version should be set to^4.0.0
before installing - if you're enabling the SPARQL page, please copy the
sparql.vue
page from the prez-ui source code into your template
For other use cases, see the below packages that are available.
Prez UI is comprised of 4 NPM packages:
prez-lib
: the JavaScript library containing RDF processing logicprez-components
: the Vue.js component libraryprez-ui
: the base layer Nuxt applicationcreate-prez-app
: the NPX starter template for initialising a Prez UI theme
flowchart LR
A{I want a<br> web UI} -->|No| B(prez-lib)
A --> |Yes| C{I want to<br> use Vue}
C -->|No| B
C -->|Yes| D{I want to<br> run Prez UI}
D -->|No| E(prez-components)
D -->|Yes| F(create-prez-app)
This version of Prez UI and the contents of this repository are also available under the BSD-3-Clause License. See this repository's LICENSE file for details.