Stripes
Copyright (C) 2017-2021 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. In addition to being the home of Stripes framework, this repository serves as a hub for shared Stripes documentation.
Background
- Stripes framework - A brief overview of the Stripes framework package
- Overview of Stripes - Concepts that guided the design of Stripes
- Stripes entities - Terminology of things pertaining to Stripes
Developing with Stripes
Getting started and new environment setup
- Quick start guide
- New development setup guide - More detailed overview
- Hello World - Use Stripes CLI to create a hello world app for FOLIO
Guides for development and testing
- Stripes module developer's guide
- Stripes CLI user guide
- Migrate to Stripes framework - How to migrate an existing app to Stripes framework v1.0
- Stripes-core - Details on Stripes core features including permissions and settings
- Stripes-components - The UI component library for Stripes
- Unit Testing with Jest and RTL
- Integration test guide - Integration tests with Nightmare (placeholder) Note: The old documentation is still mostly relevant, but tests are now invoked by the CLI
- Accessibility (a11y) in Stripes
- Internationalization (i18n) best practices - Overview and examples
- Release procedure - For all front-end
ui-*andstripes-*modules - Depending on unreleased features
- Troubleshooting guide - An evolving troubleshooting guide
Implementing Stripes
Guides for dev-ops and platform implementors
- Overview of the tenant config, aka
stripes.config.js(placeholder) - Branding guide - Apply a logo and favicon
- Build a platform - Use the CLI to create a production build
Additional information
See project STRIPES at the FOLIO issue tracker.
Other FOLIO Developer documentation is at dev.folio.org