UB-Mannheim / ui-library

Design pattern and component library for Public Knowledge Project's applications

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 and sandbox environment for component development and testing. The style guide is intended to help orient developers to the existing components, outline markup guidelines, and provide details on how to adhere to accessibility requirements.

The style guide components are for demonstration purposes. In most cases, they are not fully functional and do not provide complete documentation. You should consult the source code for these components.

Usage

This library is intended to be included and used within PKP's applications. It can also be run locally as a standalone app to develop and test components, and provide implementation guidance.

To get started:

# install dependencies
npm install

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

Issues

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