Welcome to base Showroom Backend’s documentation!#

Showroom is the showcasing component of the open source CRIS (current research information system) Portfolio. For background information on the project, visit the Portfolio/Showroom website. It is developed by the base dev team at the University of Applied Arts Vienna.

The Showroom Backend is the component containing all entries and activities, which users of Portfolio have published. Those entries are transformed to be displayed and searched for by the Showroom Frontend.

For how Showroom is built and why it is built in that way, take a look at the Architecture and data model section. This might be helpful to understand the entanglement of this component with Portfolio but also the CAS/UserPreferences component, without which no entity information will be available in Showroom. Once you get the big picture Installation guide will guide you to a first running version of the Showroom backend, and how to set it up.

The rest of the sections give you a little more insight into how the Configuration works in detail, the Management commands you can use, some context for the REST API and the available API Plugins, a few words on the Activity list generation logic, that is used to create sub-structured lists of activities for entity pages. Also the Search logic section explains how search works in Showroom and it also contains the source definition of all available filters and how they are supposed to work.

Overview & Setup

Developer References