GabrielMajeri / ui-library

PKP UI Library

A design pattern and component library for Public Knowledge Project's applications Open Journal Systems and Open Monograph Press.

About

This library contains design patterns implemented or planned for the Public Knowledge Project's applications Open Journal Systems and Open Monograph Press.

This library can also be run locally to provide a style guide, component documentation, and a sandbox environment for component development and testing.

Usage

This library is intended to be included and used within PKP's applications. If you would like to run the style guide and component documentation locally, follow these steps.

# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run serve

Run the following command to build the library with a base path of /dev/ui-library/<version>, so it can be included in PKP's documentation hub.

PKP_DOCS_VERSION=<version> npm run build

Issues

Please file any development issues or questions with the pkp/pkp-lib repository.