# 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](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](doc/stripes-framework.md), this repository serves as a hub for shared Stripes documentation.

## Background

* [Stripes framework](doc/stripes-framework.md) - A brief overview of the Stripes framework package
* [Overview of Stripes](doc/overview.md) - Concepts that guided the design of Stripes
* [Stripes entities](doc/modules-apps-etc.md) - Terminology of things pertaining to Stripes

## Developing with Stripes

Getting started and new environment setup

* [Quick start guide](doc/quick-start.md)
* [New development setup guide](doc/new-development-setup.md) - More detailed overview
* [Hello World](https://github.com/folio-org/stripes-cli/blob/master/doc/user-guide.md#app-development) - Use Stripes CLI to create a hello world app for FOLIO

Guides for development and testing

* [Stripes module developer's guide](doc/dev-guide.md)
* [Stripes CLI user guide](https://github.com/folio-org/stripes-cli/blob/master/doc/user-guide.md)
* [Migrate to Stripes framework](doc/stripes-framework.md#migrating) - How to migrate an existing app to Stripes framework v1.0
* [Stripes-core](https://github.com/folio-org/stripes-core/blob/master/README.md)  - Details on Stripes core features including permissions and settings
* [Stripes-components](https://github.com/folio-org/stripes-components/blob/master/README.md) - The UI component library for Stripes
* [Unit Testing with Jest and RTL](doc/unit-testing-with-jest-and-rtl.md)
* Integration test guide - Integration tests with Nightmare (placeholder) _Note: The [old documentation](https://github.com/folio-org/ui-testing/blob/master/README.md) is still mostly relevant, but tests are now invoked by the CLI_
* [Accessibility (a11y) in Stripes](https://github.com/folio-org/stripes-components/blob/master/guides/accessibility/AboutAccessibility.stories.mdx)
* [Internationalization (i18n) best practices](doc/i18n.md) - Overview and examples
* [Release procedure](doc/release-procedure.md) - For all front-end `ui-*` and `stripes-*` modules
* [Depending on unreleased features](doc/depending-on-unreleased-features.md)
* [Troubleshooting guide](doc/troubleshooting.md) - An evolving troubleshooting guide

## TypeScript support

Typings for the Stripes framework may be found in [stripes-types](https://github.com/folio-org/stripes-types)

## Implementing Stripes

Guides for dev-ops and platform implementors

* Overview of the tenant config, aka `stripes.config.js` (placeholder)
* [Branding guide](doc/branding.md) - Apply a logo and favicon
* [Build a platform](https://github.com/folio-org/stripes-cli/blob/master/doc/user-guide.md#generating-a-production-build) - Use the CLI to create a production build


## Additional information

See project [STRIPES](https://issues.folio.org/browse/STRIPES)
at the [FOLIO issue tracker](https://dev.folio.org/guidelines/issue-tracker/).

Other FOLIO Developer documentation is at [dev.folio.org](https://dev.folio.org/)