k-int / stripes-core

The core of Stripes, an opinionated and modular platform for React components consuming REST data and the UI framework for the FOLIO project

Stripes Core

Copyright (C) 2017 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.

Introduction

Stripes is a toolkit for building single-page web applications that FOLIO UI modules can run in. UI modules are made up of React components, some of which will be connected to back-end services provided by Okapi. Each module has a "type" which indicates how it functions within the application. At the moment, the only "type" is "app" which provides a top-level component to render into a large content area.

Documentation roadmap

• Quick start guide will allow you get Stripes up and running with a couple of sample modules downloaded using NPM, and to run locally a developed module.
• Overview of the Stripes architecture explains the concepts that guided the design of Stripes.
• Running a complete FOLIO system goes further into explaining how you can also run your own instances of FOLIO's API gateway Okapi and application service modules, and how you can use the Okapi Console (running as part of Stripes) to manage modules and tenants.
• The stripes-connect API describes how to use Stripes Connect, the part of the Stripes toolkit that allows you to declaratively express what data you want to share with back-end services.
• A component example: the PatronEdit component walks through a simple example of a component that is connected to the back-end service using Stripes Connect. NOTE that this is somewhat out of date, but still helpfully illustrative.
• A component hierarchy example: the "Patrons" module shows by example how a set of components -- some connected, some not -- can work together to implement part of an application.