Skip FOLIO Project Navigation

Introduction

List of FOLIO modules hosted at the folio-org GitHub organization, with links to some related documentation. Also refer to the Source-code overview.

Last gathered date: 24 November 2020 (194 repositories). See usage notes below.

Frontend ui repos

39 repositories.

A-I

ui-acquisition-units

Description: Stripes UI module: Management of Acquisition unit records

The ui-acquisition-units repo is used for the management of Acquisition unit records in FOLIO. It includes summary information and details regarding the Acquisition unit interaction and preferences.

GitHub README: https://github.com/folio-org/ui-acquisition-units

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Acquisition+units

ui-agreements

Description: Stripes front end module for ERM module

The Agreements UI Module, or ui-agreements, is a Stripes UI module used for management of various E-resource tasks including handling agreements and viewing available E-resources.

GitHub README: https://github.com/folio-org/ui-agreements

App tips: https://wiki.folio.org/display/FOLIOtips/Agreements

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Agreements

ui-audit

Description: Stripes UI module: Viewing audit trails

Stripes UI module- Audit app visually conveys the idea of examining past activity, organized by different points of view: user; resource; circulation etc

GitHub README: https://github.com/folio-org/ui-audit

ui-calendar

Description: FOLIO institutional calendar UI module

This is a Stripes UI module for institutional calendar functions.

GitHub README: https://github.com/folio-org/ui-calendar

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Calendar

Other documentation:
https://github.com/folio-org/ui-calendar/blob/master/GUIDE.md

ui-checkin

Description: Stripes UI for checking in items with simulated scans

This is a Stripes UI module for checking items in with simulated scans of barcodes

GitHub README: https://github.com/folio-org/ui-checkin

App tips: https://wiki.folio.org/display/FOLIOtips/Check+in

ui-checkout

Description: Stripes UI for checking out items with simulated scans

This is a Stripes UI module for checking items out with simulated scans of patron card and item barcode.

GitHub README: https://github.com/folio-org/ui-checkout

App tips: https://wiki.folio.org/display/FOLIOtips/Check+out

ui-circulation

Description: [Not provided]

This is a Stripes UI module for Circulation management.

GitHub README: https://github.com/folio-org/ui-circulation

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Circulation

ui-circulation-log

Description: [Not provided]

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-circulation-log and start your development.

GitHub README: https://github.com/folio-org/ui-circulation-log

ui-courses

Description: Course reserves UI for FOLIO

The Course Reserves UI Module, or ui-courses, is a Stripes UI module used for maintaining information about courses, and associated course reserves with them. (A 'Stripes UI module' is an NPM module that adheres to certain conventions that allow it to function within the Stripes UI framework that is part of FOLIO.)

GitHub README: https://github.com/folio-org/ui-courses

GitHub other documentation: https://github.com/folio-org/ui-courses/tree/master/doc

App tips: https://wiki.folio.org/pages/viewpage.action?pageId=36569951

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Courses

ui-data-export

Description: UI module: data export managing

Application for data export functionality.

GitHub README: https://github.com/folio-org/ui-data-export

App tips: https://wiki.folio.org/display/FOLIOtips/Data+Export

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Data+export

ui-data-import

Description: UI module: managing batch loader feature

Application for Data Import functionality

GitHub README: https://github.com/folio-org/ui-data-import

App tips: https://wiki.folio.org/display/FOLIOtips/Data+Import

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Data+import

ui-datasets

Description: [Not provided]

GitHub README: https://github.com/folio-org/ui-datasets

ui-developer

Description: Stripes UI module: developer facilities

This is a Stripes UI module for managing developer settings. This will not be included in production deployments.

GitHub README: https://github.com/folio-org/ui-developer

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Developer

ui-eholdings

Description: FOLIO eholdings App

The ui-eholdings module adds the ability to manage electronic holdings in FOLIO. The first supported knowledge base is from EBSCO.

GitHub README: https://github.com/folio-org/ui-eholdings

GitHub other documentation: https://github.com/folio-org/ui-eholdings/tree/master/docs

App tips: https://wiki.folio.org/display/FOLIOtips/eHoldings

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+eHoldings

ui-erm-comparisons

Description: Stripes App for ERM Comparison

The ERM comparisons module, or ui-erm-comparisons, is a Stripes UI module used for comparison of 'Agreement' and/or 'Package' objects defined by the ui-agreements (Agreements) module.

GitHub README: https://github.com/folio-org/ui-erm-comparisons

ui-erm-usage

Description: Stripes UI for managing ERM usage statistics

The ERM-Usage UI Module, or ui-erm-usage, is a Stripes UI module for managing usage statistics. It allows to enter credentials for accessing usage data providers. These credentials are used by the backend module mod-erm-usage to harvest usage statistics periodically.

GitHub README: https://github.com/folio-org/ui-erm-usage

GitHub other documentation: https://github.com/folio-org/ui-erm-usage/tree/master/docs

App tips: https://wiki.folio.org/display/FOLIOtips/eUsage

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+eUsage

ui-finance

Description: [Not provided]

The ui-finance allows for the management of ledgers, funds, and budgets in FOLIO. It includes a dashboard that provides a snapshot of your account totals for the current fiscal year across ledgers and funds.

GitHub README: https://github.com/folio-org/ui-finance

App tips: https://wiki.folio.org/display/FOLIOtips/Finance

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Finance

ui-finc-config

Description: UI finc-config module

This is a Stripes UI module for administrating metadata sources and collections for the finc user community.

GitHub README: https://github.com/folio-org/ui-finc-config

ui-finc-select

Description: finc-select UI module

This is a Stripes UI module for the selection of metadata sources and collections for the finc user community.

GitHub README: https://github.com/folio-org/ui-finc-select

ui-inventory

Description: UI module for administrating instances

This is a Stripes UI module for administrating locally created instances, holdings records and items.

GitHub README: https://github.com/folio-org/ui-inventory

App tips: https://wiki.folio.org/display/FOLIOtips/Inventory

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Inventory

ui-invoice

Description: [Not provided]

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-invoice and start your development.

GitHub README: https://github.com/folio-org/ui-invoice

App tips: https://wiki.folio.org/display/FOLIOtips/Invoices

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Invoices

J-R

ui-licenses

Description: FOLIO front end module for licenses

The Licenses UI Module, or ui-licenses, is a Stripes UI module used for management of licenses

GitHub README: https://github.com/folio-org/ui-licenses

App tips: https://wiki.folio.org/display/FOLIOtips/Licenses

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Licenses

ui-local-kb-admin

Description: FOLIO App Module to manage the local KB for ERM

The Local KB admin UI Module, or ui-local-kb-admin, is a Stripes UI module used for management of the local KB used for ERM tasks handled by the ui-agreements (Agreements) module.

GitHub README: https://github.com/folio-org/ui-local-kb-admin

App tips: https://wiki.folio.org/display/FOLIOtips/Local+KB+Admin

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Local+KB+admin

ui-lti-courses

Description: FOLIO UI module to configure settings for the Course Reserves LTI Tool

This is a Folio Stripes settings module that provides a front-end for configuring various things for the edge-lti-courses Edge module that uses the LTI 1.3 standard to connect Learning Management Systems (LMSs) such as Sakai, Canvas, or Blackboard to Folio's Course Reserves app.

GitHub README: https://github.com/folio-org/ui-lti-courses

ui-marccat

Description: UI module for searching, sorting, filtering, viewing, editing and creating BIB record

The MARCcat UI Module, or ui-marccat, is a Stripes UI module used for searching, sorting, filtering, viewing, editing and creating BIB record. (A 'Stripes UI module' is an NPM module that adheres to certain conventions that allow it to function within the Stripes UI framework that is part of FOLIO.)

GitHub README: https://github.com/folio-org/ui-marccat

App tips: https://wiki.folio.org/display/FOLIOtips/MARCcat

ui-myprofile

Description: UI module: managing user profile settings

This is a Stripes UI module for managing user profile settings. This exists only to provide a settings section: there is no app.

GitHub README: https://github.com/folio-org/ui-myprofile

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+My+profile

ui-notes

Description: FOLIO Notes Helper App

This is a Stripes UI module for dealing with the notes.

GitHub README: https://github.com/folio-org/ui-notes

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Notes

ui-oai-pmh

Description: Stripes UI for oai-pmh

This is a Stripes UI module for OAI-PMH management.

GitHub README: https://github.com/folio-org/ui-oai-pmh

App tips: https://wiki.folio.org/display/FOLIOtips/OAI-PMH

ui-orders

Description: [Not provided]

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-orders and start your development.

GitHub README: https://github.com/folio-org/ui-orders

App tips: https://wiki.folio.org/display/FOLIOtips/Orders

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Orders

ui-organizations

Description: UI module for managing organization records

The ui-organizations allows for the management of Organization records in FOLIO. It includes summary information, contact information and other details regarding the organization interaction and preferences.

GitHub README: https://github.com/folio-org/ui-organizations

App tips: https://wiki.folio.org/pages/viewpage.action?pageId=14457393

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Organizations

ui-quick-marc

Description: Stripes UI for quickMARC editor

This package furnishes a single Stripes plugin of type quick-marc, which can be included in Stripes modules by means of a <Pluggable type='quick-marc'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-quick-marc

App tips: https://wiki.folio.org/display/FOLIOtips/quickMARC

ui-receiving

Description: [Not provided]

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-receiving and start your development.

GitHub README: https://github.com/folio-org/ui-receiving

App tips: https://wiki.folio.org/display/FOLIOtips/Receiving

ui-remote-storage

Description: [Not provided]

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-remote-storage and start your development.

GitHub README: https://github.com/folio-org/ui-remote-storage

ui-requests

Description: Stripes UI module for making requests on items

This is a Stripes UI module for making requests on items.

GitHub README: https://github.com/folio-org/ui-requests

App tips: https://wiki.folio.org/display/FOLIOtips/Requests

S-Z

Description: [Not provided]

The Search UI Module, or ui-search, is a Stripes UI module used for searching, sorting, filtering and viewing records from the FOLIO Codex, an aggregation of bibliographic metadata from multiple sources.

GitHub README: https://github.com/folio-org/ui-search

GitHub other documentation: https://github.com/folio-org/ui-search/tree/master/doc

App tips: https://wiki.folio.org/display/FOLIOtips/Codex+search

ui-servicepoints

Description: Service Points handler module for Stripes

This package include a Stripes handler module called servicepoints which will be executed during stripes-core initialization.

GitHub README: https://github.com/folio-org/ui-servicepoints

ui-tags

Description: UI module for managing tag settings

This is a Stripes UI module for Tags management.

GitHub README: https://github.com/folio-org/ui-tags

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Tags

ui-tenant-settings

Description: Stripes UI module: managing tenant settings

This is a Stripes UI module for managing organization settings. This exists only to provide a settings section: there is no app.

GitHub README: https://github.com/folio-org/ui-tenant-settings

ui-users

Description: Stripes UI module: administrating users

The Users UI Module, or ui-users, is a Stripes UI module used for searching, sorting, filtering, viewing, editing and creating users. (A 'Stripes UI module' is an NPM module that adheres to certain conventions that allow it to function within the Stripes UI framework that is part of FOLIO.)

GitHub README: https://github.com/folio-org/ui-users

App tips: https://wiki.folio.org/display/FOLIOtips/Users

App settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Users

Other documentation:
https://wiki.folio.org/display/FOLIOtips/Users+App+-+Creating+Fees+and+Fines

Frontend ui plugin repos

17 repositories.

A-N

ui-plugin-create-inventory-records

Description: [Not provided]

This package furnishes a single Stripes plugin of type create-inventory-records, which can be included in Stripes modules by means of a <Pluggable type='create-inventory-records'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-create-inventory-records

ui-plugin-create-item

Description: Stripes UI plugin: Create item

This package furnishes a single Stripes plugin of type create-item, which can be included in Stripes modules by means of a <Pluggable type='create-item'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-create-item

ui-plugin-example

Description: A Stripes UI plugin for editing markdown

This source module contains the code for several Stripes UI plugins. They exists only to test the plugin support, and do not provide useful functionality.

GitHub README: https://github.com/folio-org/ui-plugin-example

ui-plugin-find-agreement

Description: ERM-agreement-finder plugin for Stripes

This package furnishes a single Stripes plugin of type find-agreement, which can be included in Stripes modules by means of a <Pluggable type='find-agreement'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-find-agreement

ui-plugin-find-contact

Description: Stripes UI plugin: Find a contact

This package furnishes a single Stripes plugin of type find-contact, which can be included in Stripes modules by means of a <Pluggable type='find-contact'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-find-contact

ui-plugin-find-eresource

Description: ERM-eresource-finder plugin for Stripes

This package furnishes a single Stripes plugin of type find-eresource, which can be included in Stripes modules by means of a <Pluggable type='find-eresource'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-find-eresource

ui-plugin-find-erm-usage-data-provider

Description: ERM-Usage-Data-Provider-finder plugin for Stripes

This package furnishes a single Stripes plugin of type find-erm-usage-data-provider, which can be included in Stripes modules by means of a <Pluggable type='find-erm-usage-data-provider'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-find-erm-usage-data-provider

ui-plugin-find-finc-metadata-collection

Description: Finder plugin for finc metadata collections

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-plugin-find-finc-metadata-collection and start your development.

GitHub README: https://github.com/folio-org/ui-plugin-find-finc-metadata-collection

ui-plugin-find-finc-metadata-source

Description: Finder plugin for finc metadata sources

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-plugin-find-finc-metadata-source and start your development.

GitHub README: https://github.com/folio-org/ui-plugin-find-finc-metadata-source

ui-plugin-find-import-profile

Description: UI Plugin that implements UI Data Import profiles search and pick

This package furnishes a single Stripes plugin of type find-import-profile, which can be included in Stripes modules by means of a <Pluggable type='find-import-profile'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-find-import-profile

ui-plugin-find-instance

Description: Instance-finder plugin for Stripes

This package furnishes a single Stripes plugin of type find-instance, which can be included in Stripes modules by means of a <Pluggable type='find-instance'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-find-instance

ui-plugin-find-interface

Description: Stripes UI plugin: Find an interface

This package furnishes a single Stripes plugin of type find-interface, which can be included in Stripes modules by means of a <Pluggable type='find-interface'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-find-interface

ui-plugin-find-license

Description: UI Widget to lookup or create licenses

This package furnishes a single Stripes plugin of type find-license, which can be included in Stripes modules by means of a <Pluggable type='find-license'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-find-license

ui-plugin-find-organization

Description: Organization-finder plugin for Stripes

This package furnishes a single Stripes plugin of type find-organization, which can be included in Stripes modules by means of a <Pluggable type='find-organization'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-find-organization

ui-plugin-find-package-title

Description: Stripes plugin to find packages and titles

This package furnishes a single Stripes plugin of type find-package-title, which can be included in Stripes modules by means of a <Pluggable type='find-package-title'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-find-package-title

ui-plugin-find-po-line

Description: Stripes UI plugin: Display, filter and select PO lines

This package furnishes a single Stripes plugin of type find-po-line, which can be included in Stripes modules by means of a <Pluggable type='find-po-line'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-find-po-line

ui-plugin-find-user

Description: User-finder plugin for Stripes

This package furnishes a single Stripes plugin of type find-user, which can be included in Stripes modules by means of a <Pluggable type='find-user'> element. See the Plugins section of the Module Developer's Guide.

GitHub README: https://github.com/folio-org/ui-plugin-find-user

Stripes repos

16 repositories.

A-N

O-Z

stripes

Description: UI framework for building front-end FOLIO modules

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.

GitHub README: https://github.com/folio-org/stripes

GitHub other documentation: https://github.com/folio-org/stripes/tree/master/doc

stripes-acq-components

Description: Stripes components that are specific to use cases that arise in Acquisitions-related modules

This is a library of React components and utility functions for use with the Stripes UI toolkit, part of the FOLIO project.

GitHub README: https://github.com/folio-org/stripes-acq-components

stripes-cli

Description: Command line interface for creating, building, and testing Stripes UI modules.

Stripes CLI is a command line interface to facilitate the creation, development, building, and testing of Stripes UI modules.

GitHub README: https://github.com/folio-org/stripes-cli

GitHub other documentation: https://github.com/folio-org/stripes-cli/tree/master/doc

stripes-components

Description: A component library for Stripes

This is a library of React components and utility functions for use with the Stripes UI toolkit, part of the FOLIO project.

GitHub README: https://github.com/folio-org/stripes-components

GitHub other documentation: https://github.com/folio-org/stripes-components/tree/master/docs

Other documentation:
https://github.com/folio-org/stripes-components#links-to-documentation-of-specific-components-and-utilities
https://github.com/folio-org/stripes-components/tree/master/lib

stripes-connect

Description: Declarative REST data access for React components, part of the FOLIO project

Stripes Connect provides essentially one service: the ability to upgrade a regular React component into a Connected Component. This is done by importing the connect() method from stripes-connect, defining a data manifest, and exporting not the React component itself but the result of wrapping it in a call to connect():

GitHub README: https://github.com/folio-org/stripes-connect

GitHub other documentation: https://github.com/folio-org/stripes-connect/tree/master/doc

stripes-core

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

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.

GitHub README: https://github.com/folio-org/stripes-core

GitHub other documentation: https://github.com/folio-org/stripes-core/tree/master/doc

stripes-data-transfer-components

Description: Stripes components that are specific to use cases that arise in ui-data-import and ui-data-export modules

This is a library of React components and utility functions for use with the Stripes UI toolkit, part of the FOLIO project.

GitHub README: https://github.com/folio-org/stripes-data-transfer-components

stripes-demo-platform

Description: Stripes platform for building the demo site

GitHub README: https://github.com/folio-org/stripes-demo-platform

stripes-erm-components

Description: Stripes components that are specific to use cases that arise in ERM-related modules

This is a library of React components and utility functions for use with the Stripes UI toolkit, part of the FOLIO project.

GitHub README: https://github.com/folio-org/stripes-erm-components

stripes-final-form

Description: A Final Form Wrapper for Stripes

GitHub README: https://github.com/folio-org/stripes-final-form

stripes-form

Description: A redux-form wrapper for Stripes

GitHub README: https://github.com/folio-org/stripes-form

stripes-sample-platform

Description: Configuration for a sample platform and to run a local Stripes UI development server

GitHub README: https://github.com/folio-org/stripes-sample-platform

stripes-smart-components

Description: [Not provided]

A suite of smart components. Each communicates with an Okapi web-service in order to provide the facilities that it renders.

GitHub README: https://github.com/folio-org/stripes-smart-components

Other documentation:
https://github.com/folio-org/stripes-smart-components/tree/master/lib

stripes-template-editor

Description: [Not provided]

This is a NPM module to aid with embedding the Quill editor in Stripes applications for building templates with token substitution.

GitHub README: https://github.com/folio-org/stripes-template-editor

stripes-testing

Description: [Not provided]

stripes-testing is a toolkit for building integration tests against Stripes UI modules and platforms. There are no tests in this repository; instead they exist in the platforms they exercise (e.g. platform-core). Tests that operate only a single app (unit tests) should be written with the BigTest toolkit instead.

GitHub README: https://github.com/folio-org/stripes-testing

GitHub other documentation: https://github.com/folio-org/stripes-testing/tree/master/doc

stripes-util

Description: A library of utility functions to support Stripes modules

A library of utility functions to support Stripes modules.

GitHub README: https://github.com/folio-org/stripes-util

Stripes platform repos

3 repositories.

platform-complete

Description: Complete set of Stripes modules for FOLIO

This is the 'complete' Stripes 'platform'. It consists simply of an NPM package.json that specifies the version of @folio/stripes-core and of any Stripes modules you wish to make available as part of this platform to generate client bundles along with a utility for generating module descriptors for each Stripes module.

GitHub README: https://github.com/folio-org/platform-complete

platform-core

Description: Core set of Stripes modules for FOLIO

This is the 'core' Stripes 'platform'. It consists simply of an NPM package.json that specifies the version of @folio/stripes-core and of any Stripes modules you wish to make available as part of the 'core' platform to generate client bundles along with a utility for generating module descriptors for each Stripes module.

GitHub README: https://github.com/folio-org/platform-core

platform-erm

Description: FOLIO Stripes platform for ERM modules

This is the ERM Stripes 'platform'. It consists simply of an NPM package.json that specifies the version of @folio/stripes-core and of any Stripes modules you wish to make available as part of the ERM platform to generate client bundles along with a utility for generating module descriptors for each Stripes module.

GitHub README: https://github.com/folio-org/platform-erm

Backend mod repos

68 repositories.

A-F

mod-aes

Description: Provide asynchronous event service (AES)

The mod-aes module implements FOLIO asynchronous event service (AES). Currently, it acts as a filter to capture traffic as JSON messages. It then routes the messages to different Kafka topic according to JSON path based routing rules that are stored in mod-config.

GitHub README: https://github.com/folio-org/mod-aes

mod-agreements

Description: A FOLIO Module for handling the server side work needed for the ERM system

Mod-Agreements is a FOLIO module to manage agreements which control an institutions access to resources. Normally, this will be subscribed access to packages of electronic resources, although the aim is to make the affordances offered by mod-agreements as general as possible.

GitHub README: https://github.com/folio-org/mod-agreements

GitHub other documentation: https://github.com/folio-org/mod-agreements/tree/master/doc

mod-audit

Description: Module for managing audit data

The mod-audit module provides API to access and modify audit data.

GitHub README: https://github.com/folio-org/mod-audit

GitHub RAMLs directory: https://github.com/folio-org/mod-audit/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-audit

mod-audit-filter

Description: Module for implementing Okapi Pre and Post filters to capture audit data

The audit-filter module implements Okapi PRE and POST filters to capture audit data. It then calls mod-audit to persist the data.

GitHub README: https://github.com/folio-org/mod-audit-filter

mod-authtoken

Description: Module for filtering requests based on JWT tokens

This module is responsible for filtering all proxy traffic and checking for a valid token. In addition, it is responsible for retrieving the permissions for a given user and making decisions regarding access based on user permissions and defined requirements for a given path. It provides a token creation endpoint that privileged modules (such as Authentication) may make use of.

GitHub README: https://github.com/folio-org/mod-authtoken

mod-calendar

Description: [Not provided]

Module to provide calendar functionalities for FOLIO systems.

GitHub README: https://github.com/folio-org/mod-calendar

GitHub DB schema: https://github.com/folio-org/mod-calendar/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-calendar/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-calendar

mod-camunda

Description: [Not provided]

GitHub README: https://github.com/folio-org/mod-camunda

mod-circulation

Description: FOLIO mod-circulation

FOLIO compatible circulation capabilities, including loan items from the inventory.

GitHub README: https://github.com/folio-org/mod-circulation

GitHub other documentation: https://github.com/folio-org/mod-circulation/tree/master/doc

GitHub RAMLs directory: https://github.com/folio-org/mod-circulation/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-circulation

mod-circulation-storage

Description: FOLIO mod-circulation-storage

FOLIO compatible persistent storage of loans, loan policies, circulation rules, requests, and fixed due date schedules

GitHub README: https://github.com/folio-org/mod-circulation-storage

GitHub DB schema: https://github.com/folio-org/mod-circulation-storage/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-circulation-storage/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-circulation-storage

mod-codex-ekb

Description: [Not provided]

Codex wrapper for the EBSCO knowledge base.

GitHub README: https://github.com/folio-org/mod-codex-ekb

GitHub RAMLs directory: https://github.com/folio-org/mod-codex-ekb/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-codex-ekb

mod-codex-inventory

Description: Codex wrapper for local inventory

Codex Wrapper for Inventory

GitHub README: https://github.com/folio-org/mod-codex-inventory

GitHub RAMLs directory: https://github.com/folio-org/mod-codex-inventory/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-codex-inventory

mod-codex-mock

Description: Codex mock module - for testing and development

Codex mock module - for testing and development

GitHub README: https://github.com/folio-org/mod-codex-mock

GitHub DB schema: https://github.com/folio-org/mod-codex-mock/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-codex-mock/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-codex-mock

mod-codex-mux

Description: Codex Multiplexer backend module

Codex Multiplexer backend module

GitHub README: https://github.com/folio-org/mod-codex-mux

GitHub RAMLs directory: https://github.com/folio-org/mod-codex-mux/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-codex-mux

mod-configuration

Description: Configuration module based on the raml-module-builder and a set of raml and json schemas backed by a postgresdb async implementation

Configuration module based on the raml-module-builder and a set of raml and json schemas backed by a PostgreSQL async implementation

GitHub README: https://github.com/folio-org/mod-configuration

GitHub DB schema: https://github.com/folio-org/mod-configuration/blob/master/mod-configuration-server/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-configuration/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-configuration

mod-copycat

Description: Backend module for importing records from remote systems for copy cataloging

mod-copycat is a FOLIO module that assists in Copy cataloging. It imports records from remote systems using Z39.50.

GitHub README: https://github.com/folio-org/mod-copycat

GitHub DB schema: https://github.com/folio-org/mod-copycat/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-copycat/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-copycat

mod-courses

Description: Backend CRUD storage module to support the Course Reserves functionality

Backend CRUD storage module to support the Course Reserves functionality

GitHub README: https://github.com/folio-org/mod-courses

GitHub DB schema: https://github.com/folio-org/mod-courses/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-courses/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-courses

mod-data-export

Description: Exporting inventory records

FOLIO data export module.

GitHub README: https://github.com/folio-org/mod-data-export

GitHub DB schema: https://github.com/folio-org/mod-data-export/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-data-export/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-data-export

mod-data-import

Description: [Not provided]

FOLIO data import module.

GitHub README: https://github.com/folio-org/mod-data-import

GitHub DB schema: https://github.com/folio-org/mod-data-import/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-data-import/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-data-import

mod-data-import-converter-storage

Description: Data import converter storage

Data Import Converter Storage.

GitHub README: https://github.com/folio-org/mod-data-import-converter-storage

GitHub RAMLs directory: https://github.com/folio-org/mod-data-import-converter-storage/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-data-import-converter-storage

mod-data-loader

Description: RMB based module used to load test data

RMB-based module used to load test data.

GitHub README: https://github.com/folio-org/mod-data-loader

GitHub RAMLs directory: https://github.com/folio-org/mod-data-loader/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-data-loader

mod-datasets

Description: Glint server module wrapper for FOLIO

GitHub README: https://github.com/folio-org/mod-datasets

mod-email

Description: Provides functionality for sending notifications

The module provides the role of delivering messages using SMTP server to send email. This module use mod-configuration to get connection parameters.

GitHub README: https://github.com/folio-org/mod-email

GitHub DB schema: https://github.com/folio-org/mod-email/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-email/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-email

mod-erm-usage

Description: Store ERM usage statistics and access data to these statistics

GitHub README: https://github.com/folio-org/mod-erm-usage

GitHub RAMLs directory: https://github.com/folio-org/mod-erm-usage/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-erm-usage

mod-erm-usage-counter

Description: Library containing models and clients for COUNTER/SUSHI standard

Models, Clients and Utilities for COUNTER/SUSHI standard

GitHub README: https://github.com/folio-org/mod-erm-usage-counter

mod-erm-usage-harvester

Description: Harvest ERM usage statistics

Module for harvesting counter reports.

GitHub README: https://github.com/folio-org/mod-erm-usage-harvester

GitHub RAMLs directory: https://github.com/folio-org/mod-erm-usage-harvester/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-erm-usage-harvester

mod-event-config

Description: Provides functionality for the notification events

The module provides information describing the notification events. The event configuration describes the event name, delivery channels, and contain references to templates for each delivery channel.

GitHub README: https://github.com/folio-org/mod-event-config

GitHub DB schema: https://github.com/folio-org/mod-event-config/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-event-config/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-event-config

mod-feesfines

Description: Provide central management for fees and fines

Module to provide central feesfines management for FOLIO systems.

GitHub README: https://github.com/folio-org/mod-feesfines

GitHub DB schema: https://github.com/folio-org/mod-feesfines/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-feesfines/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-feesfines

mod-finance

Description: Finance business logic

This is the user-facing, business logic module for finances, which is comprised of this module and mod-finance-storage.

GitHub README: https://github.com/folio-org/mod-finance

GitHub RAMLs directory: https://github.com/folio-org/mod-finance/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-finance

mod-finance-storage

Description: CRUD module to manage finance-data (i.e. ledgers, funds, budgets, etc.)

This RMB-module is responsible for the persistence of finance-related data (i.e. funds, ledgers, transactions, etc.)

GitHub README: https://github.com/folio-org/mod-finance-storage

GitHub DB schema: https://github.com/folio-org/mod-finance-storage/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-finance-storage/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-finance-storage

mod-finc-config

Description: Knowledge base for amsl's finc-config module

Backend module for finc-config and finc-select.

GitHub README: https://github.com/folio-org/mod-finc-config

GitHub DB schema: https://github.com/folio-org/mod-finc-config/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-finc-config/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-finc-config

G-L

mod-gobi

Description: [Not provided]

GOBI® (Global Online Bibliographic Information) is the leading web-based acquisitions tool for finding, ordering and managing e-books and print books for libraries. This module allows GOBI initiated orders to be fulfilled by FOLIO.

GitHub README: https://github.com/folio-org/mod-gobi

GitHub RAMLs directory: https://github.com/folio-org/mod-gobi/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-gobi

mod-graphql

Description: FOLIO module for executing GraphQL queries

mod-graphql is a FOLIO module, written in Node.js, that provides a GraphQL service by HTTP POST to /graphql/. It can be interrogated using any GraphQL client library, such as Apollo, and the graph it provides is auto-generated from the API description files (RAML and JSON Schema) of the modules that it's providing the GraphQL API for.

GitHub README: https://github.com/folio-org/mod-graphql

GitHub other documentation: https://github.com/folio-org/mod-graphql/tree/master/doc

mod-inventory

Description: [Not provided]

FOLIO compatible inventory module.

GitHub README: https://github.com/folio-org/mod-inventory

GitHub other documentation: https://github.com/folio-org/mod-inventory/tree/master/doc

GitHub RAMLs directory: https://github.com/folio-org/mod-inventory/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-inventory

mod-inventory-storage

Description: [Not provided]

FOLIO compatible inventory storage module.

GitHub README: https://github.com/folio-org/mod-inventory-storage

GitHub DB schema: https://github.com/folio-org/mod-inventory-storage/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-inventory-storage/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-inventory-storage

mod-inventory-update

Description: Provides different update schemes for populating a FOLIO Inventory Storage

Mod-inventory-update is an Okapi service that can be put in front of mod-inventory-storage (Inventory Storage) for populating the storage with Instances, holdings and items according to one of multiple different update schemes.

GitHub README: https://github.com/folio-org/mod-inventory-update

GitHub RAMLs directory: https://github.com/folio-org/mod-inventory-update/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-inventory-update

mod-invoice

Description: Invoice business logic

This is the Invoice business logic module.

GitHub README: https://github.com/folio-org/mod-invoice

GitHub RAMLs directory: https://github.com/folio-org/mod-invoice/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-invoice

mod-invoice-storage

Description: Persistent storage of invoice data

This is the Invoice storage module.

GitHub README: https://github.com/folio-org/mod-invoice-storage

GitHub DB schema: https://github.com/folio-org/mod-invoice-storage/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-invoice-storage/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-invoice-storage

mod-kb-ebsco-java

Description: Broker communication with the EBSCO knowledge base (Java)

Broker communication with the EBSCO knowledge base (Java)

GitHub README: https://github.com/folio-org/mod-kb-ebsco-java

GitHub DB schema: https://github.com/folio-org/mod-kb-ebsco-java/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-kb-ebsco-java/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-kb-ebsco-java

mod-licenses

Description: FOLIO service module - licenses

FOLIO service module - licenses.

GitHub README: https://github.com/folio-org/mod-licenses

GitHub other documentation: https://github.com/folio-org/mod-licenses/tree/master/docs

GitHub RAMLs directory: https://github.com/folio-org/mod-licenses/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-licenses

mod-login

Description: Module to handle username/password login

This module is responsible for verifying the user's identity and issuing a valid JWT that can be used for system access. The implementation of this module may vary (username/password, SAML, OAuth, etc.), and it is possible for more than one Authentication module to exist in a running system. The default implementation uses a simple username and password for authentication.

GitHub README: https://github.com/folio-org/mod-login

GitHub DB schema: https://github.com/folio-org/mod-login/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-login/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-login

mod-login-saml

Description: FOLIO SAML login module

This module provides SAML2 SSO functionality for FOLIO.

GitHub README: https://github.com/folio-org/mod-login-saml

GitHub RAMLs directory: https://github.com/folio-org/mod-login-saml/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-login-saml

M-R

mod-marccat

Description: FOLIO metadata management / marccat module

FOLIO Cataloguing module.

GitHub README: https://github.com/folio-org/mod-marccat

GitHub RAMLs directory: https://github.com/folio-org/mod-marccat/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-marccat

mod-ncip

Description: NISO Circulation Interchange Protocol (NCIP) support in FOLIO

NISO Circulation Interchange Protocol (NCIP) support in FOLIO

GitHub README: https://github.com/folio-org/mod-ncip

GitHub other documentation: https://github.com/folio-org/mod-ncip/tree/master/docs

mod-notes

Description: Notes on all types of objects

Notes on all types of objects

GitHub README: https://github.com/folio-org/mod-notes

GitHub DB schema: https://github.com/folio-org/mod-notes/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-notes/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-notes

mod-notify

Description: Notifications to the users

Notifications to the users

GitHub README: https://github.com/folio-org/mod-notify

GitHub DB schema: https://github.com/folio-org/mod-notify/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-notify/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-notify

mod-oai-pmh

Description: Backend Module implementing the OAI-PMH metadata harvesting protocol

Backend Module implementing the Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH Version 2.0), but providing more RESTful API than described in the specification. At the core places the /oai/records endpoint which accepts verb name as main parameter which defines what type of request is and which handler should ve invoked for processing the request.

GitHub README: https://github.com/folio-org/mod-oai-pmh

GitHub DB schema: https://github.com/folio-org/mod-oai-pmh/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-oai-pmh/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-oai-pmh

mod-orders

Description: Orders business logic module

This is the Orders business logic module.

GitHub README: https://github.com/folio-org/mod-orders

GitHub RAMLs directory: https://github.com/folio-org/mod-orders/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-orders

mod-orders-storage

Description: Storage (CRUD) module for Orders

This is the Orders storage module.

GitHub README: https://github.com/folio-org/mod-orders-storage

GitHub DB schema: https://github.com/folio-org/mod-orders-storage/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-orders-storage/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-orders-storage

mod-organizations

Description: Organizations business logic module

This is the Organizations business logic module.

GitHub README: https://github.com/folio-org/mod-organizations

GitHub RAMLs directory: https://github.com/folio-org/mod-organizations/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-organizations

mod-organizations-storage

Description: Persistent storage of organizations data

This is the Organizations storage module.

GitHub README: https://github.com/folio-org/mod-organizations-storage

GitHub DB schema: https://github.com/folio-org/mod-organizations-storage/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-organizations-storage/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-organizations-storage

mod-password-validator

Description: Performs password validation and stores validation rules for specified tenant

The module provides a default rule set for a tenant and functionality to manage them via REST API and also allows to use a validation flow for a user password.

GitHub README: https://github.com/folio-org/mod-password-validator

GitHub DB schema: https://github.com/folio-org/mod-password-validator/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-password-validator/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-password-validator

mod-patron

Description: [Not provided]

Microservice to allow 3rd party discovery services to perform FOLIO patron actions via the discovery service's UI.

GitHub README: https://github.com/folio-org/mod-patron

GitHub RAMLs directory: https://github.com/folio-org/mod-patron/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-patron

mod-patron-blocks

Description: FOLIO module for automated patron blocks

FOLIO module for automated patron blocks

GitHub README: https://github.com/folio-org/mod-patron-blocks

GitHub DB schema: https://github.com/folio-org/mod-patron-blocks/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-patron-blocks/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-patron-blocks

mod-permissions

Description: Module to handle permissions and permissions/user associations

This module stores permissions and associations between permissions and users. It also maintains a hierarchy of permissions and sub-permissions, allowing for permissions to act as roles, rather than simple bits. It is used primarily by the Authtoken module, though it is possible that some Authentication implementations may have reason to make calls to the Permissions module as well.

GitHub README: https://github.com/folio-org/mod-permissions

GitHub DB schema: https://github.com/folio-org/mod-permissions/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-permissions/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-permissions

mod-pubsub

Description: Publisher-subscriber module to provide event-driven approach

The mod-pubsub module is responsible for maintaining the registration of EventTypes and for coordinating distribution of Events to the appropriate Subscribers. Folio modules may publish Events and/or subscribe to Events of specific EventTypes. It is the responsibility of Publisher modules to define the EventTypes that they will provide, which is accomplished through the use of an EventDescriptor. Note that it is possible for multiple Publishers to register for the same EventType. However, the EventType may only be defined once. Subscribing modules will register themselves to specific EvenTypes by providing a URI that will be invoked by the event manager when pushing events of matching EvenTypes. Event subscription is done on a per tenant basis.

GitHub README: https://github.com/folio-org/mod-pubsub

GitHub RAMLs directory: https://github.com/folio-org/mod-pubsub/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-pubsub

mod-quick-marc

Description: Backend for quickMARC editor

API for quickMARC - in-app editor for MARC records in SRS.

GitHub README: https://github.com/folio-org/mod-quick-marc

GitHub RAMLs directory: https://github.com/folio-org/mod-quick-marc/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-quick-marc

mod-receiving

Description: [Not provided]

Backend module with business logic for receiving receive and checking-in materials that have been ordered.

GitHub README: https://github.com/folio-org/mod-receiving

mod-rtac

Description: [Not provided]

Microservice to allow 3rd party discovery services to determine the availability of FOLIO inventory.

GitHub README: https://github.com/folio-org/mod-rtac

GitHub RAMLs directory: https://github.com/folio-org/mod-rtac/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-rtac

S-X

mod-sender

Description: Sending messages through delivery channels

Sending messages through delivery channels

GitHub README: https://github.com/folio-org/mod-sender

GitHub RAMLs directory: https://github.com/folio-org/mod-sender/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-sender

mod-source-record-manager

Description: [Not provided]

FOLIO source record manager module.

GitHub README: https://github.com/folio-org/mod-source-record-manager

GitHub RAMLs directory: https://github.com/folio-org/mod-source-record-manager/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-source-record-manager

mod-source-record-storage

Description: Persistent source record storage

FOLIO compatible source record storage module.

GitHub README: https://github.com/folio-org/mod-source-record-storage

GitHub RAMLs directory: https://github.com/folio-org/mod-source-record-storage/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-source-record-storage

mod-spring-sample

Description: Okapi Spring module example

GitHub README: https://github.com/folio-org/mod-spring-sample

mod-tags

Description: Central list of tags that can be assigned to various objects

Central list of tags that can be assigned to various objects. Tags are simple strings like 'urgent', or 'important'. These are kept as an array of string values in the various objects that use them. This module provides a centralized repository of allowed values, which can be used for populating pull-down lists etc. The coupling is intentionally rather weak, it will be up to the UI to enforce the use of authorized tags, or not, as each library will want, and/or insert new tags into this module when the user uses a new one.

GitHub README: https://github.com/folio-org/mod-tags

GitHub DB schema: https://github.com/folio-org/mod-tags/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-tags/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-tags

mod-template-engine

Description: Stores templates and generates files by using them

This module is responsible for storing templates and generating text, html, xml, doc, docx etc from the template. Generated payload is described by meta information which contains info about format, size and date. Supports localization of templates.

GitHub README: https://github.com/folio-org/mod-template-engine

GitHub DB schema: https://github.com/folio-org/mod-template-engine/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-template-engine/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-template-engine

mod-user-import

Description: [Not provided]

This module is responsible for importing new or already existing users into FOLIO.

GitHub README: https://github.com/folio-org/mod-user-import

GitHub RAMLs directory: https://github.com/folio-org/mod-user-import/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-user-import

mod-users

Description: Domain Model to Manage Users

Module to provide central user management for FOLIO systems.

GitHub README: https://github.com/folio-org/mod-users

GitHub DB schema: https://github.com/folio-org/mod-users/blob/master/src/main/resources/templates/db_scripts/schema.json

GitHub RAMLs directory: https://github.com/folio-org/mod-users/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-users

mod-users-bl

Description: Business logic "join" module to provide simple access to all user-centric data

Business logic 'join' module to provide simple access to all user-centric data.

GitHub README: https://github.com/folio-org/mod-users-bl

GitHub RAMLs directory: https://github.com/folio-org/mod-users-bl/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#mod-users-bl

mod-workflow

Description: [Not provided]

Introduction ... ## Additional information

GitHub README: https://github.com/folio-org/mod-workflow

Backend edge repos

9 repositories.

edge-common

Description: a shared library/framework for edge APIs

Common/Shared library for Edge APIs.

GitHub README: https://github.com/folio-org/edge-common

Other documentation:
https://wiki.folio.org/display/FOLIOtips/Edge+APIs#EdgeAPIs-edge-commonFramework

edge-lti-courses

Description: [Not provided]

The purpose of this edge module is to connect LMS such as Sakai and Blackboard (LTI Platforms) to Folio via the LTI Advantage protocol for the purposes of sharing the course reserves stored in Folio.

GitHub README: https://github.com/folio-org/edge-lti-courses

GitHub RAMLs directory: https://github.com/folio-org/edge-lti-courses/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#edge-lti-courses

edge-ncip

Description: Edge API for mod-ncip

Edge API for mod-ncip

GitHub README: https://github.com/folio-org/edge-ncip

Other documentation:
https://wiki.folio.org/display/FOLIOtips/Edge+APIs#EdgeAPIs-edge-ncip

edge-oai-pmh

Description: Edge API for Metadata Harvesting

Edge API for Metadata Harvesting (OAI-PMH Version 2.0)

GitHub README: https://github.com/folio-org/edge-oai-pmh

Other documentation:
https://wiki.folio.org/display/FOLIOtips/Edge+APIs#EdgeAPIs-edge-oai-pmh

GitHub RAMLs directory: https://github.com/folio-org/edge-oai-pmh/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#edge-oai-pmh

edge-orders

Description: [Not provided]

The purpose of this edge API is to bridge the gap between 3rd party purchasing systems/vendors and FOLIO. More specifically, the initial implementation was built with EBSCO's GOBI (Global Online Bibliographic Interface) service in mind.

GitHub README: https://github.com/folio-org/edge-orders

Other documentation:
https://wiki.folio.org/display/FOLIOtips/Edge+APIs#EdgeAPIs-edge-orders

GitHub RAMLs directory: https://github.com/folio-org/edge-orders/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#edge-orders

edge-patron

Description: [Not provided]

Edge API to interface with FOLIO for 3rd party discovery services to allow patrons to perform self-service actions (place holds, renewals, etc)

GitHub README: https://github.com/folio-org/edge-patron

Other documentation:
https://wiki.folio.org/display/FOLIOtips/Edge+APIs#EdgeAPIs-edge-patron

GitHub RAMLs directory: https://github.com/folio-org/edge-patron/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#edge-patron

edge-resolver

Description: UUID resolver

The purpose of this edge API is to bridge the gap between external reporting and analytics systems and FOLIO by allowing these systems to resolve FOLIO UUIDs, such as a FOLIO user id, thereby acquiring a richer set of data.

GitHub README: https://github.com/folio-org/edge-resolver

edge-rtac

Description: Edge API for RTAC (RealTime Availability Check)

Edge API to interface with FOLIO for 3rd party discovery services to determine holdings availability.

GitHub README: https://github.com/folio-org/edge-rtac

Other documentation:
https://wiki.folio.org/display/FOLIOtips/Edge+APIs#EdgeAPIs-edge-rtac

GitHub RAMLs directory: https://github.com/folio-org/edge-rtac/tree/master/ramls

API documentation: https://dev.folio.org/reference/api/#edge-rtac

edge-sip2

Description: 3M Standard Interchange Protocol (SIP) support in FOLIO

The purpose of this edge API is to bridge the gap between self service circulation and patron services stations and FOLIO by allowing these systems to issue requests and receive responses in Standard Interchange Protocol v2 (SIP2). These requests will be serviced by FOLIO APIs and the responses will be based on FOLIO results for all supported (TBD) SIP2 commands.

GitHub README: https://github.com/folio-org/edge-sip2

Other documentation:
https://wiki.folio.org/display/FOLIOtips/Edge+APIs#EdgeAPIs-edge-sip2

Backend infrastructure repos

2 repositories.

okapi

Description: Okapi core and modules

GitHub README: https://github.com/folio-org/okapi

GitHub other documentation: https://github.com/folio-org/okapi/tree/master/doc

Other documentation:
https://github.com/folio-org/okapi/blob/master/doc/guide.md
https://github.com/folio-org/okapi/blob/master/doc/index.md

GitHub RAMLs directory: https://github.com/folio-org/okapi/tree/master/okapi-core/src/main/raml

API documentation: https://dev.folio.org/reference/api/#okapi

raml-module-builder

Description: Framework allowing easy module creation based on RAML files

This documentation includes information about the Raml-Module-Builder (RMB) framework and examples of how to use it.

GitHub README: https://github.com/folio-org/raml-module-builder

GitHub other documentation: https://github.com/folio-org/raml-module-builder/tree/master/doc

Other documentation:
https://github.com/folio-org/raml-module-builder/blob/master/doc/upgrading.md
https://github.com/folio-org/raml-module-builder/blob/master/DB-schema-migration.md

GitHub RAMLs directory: https://github.com/folio-org/raml-module-builder/tree/master/domain-models-api-interfaces/ramls

API documentation: https://dev.folio.org/reference/api/#raml-module-builder

Shared RAML repos

3 repositories.

acq-models

Description: Central repository for the acquisition models

GitHub README: https://github.com/folio-org/acq-models

data-import-raml-storage

Description: Repository for data-import json schemas centralized for reusability

This repository contains json schemas and examples for entities involved in data-import flow. It is utilized as a git submodule ('raml-storage' directory) in each of the following repositories:

GitHub README: https://github.com/folio-org/data-import-raml-storage

raml

Description: Repository of RAML files, including JSON schemas, traits and resource types centralized for re-usability

This repository is the master location for the traits and resource types, while each module is the master for its own schemas, examples, and actual RAML files. It is included in other repositories via a git sub-module, usually called ramls/raml-util

Repository of RAML traits and resource type files.

GitHub README: https://github.com/folio-org/raml

Other documentation:
https://dev.folio.org/reference/api/#raml

Other repos

37 repositories.

A-I

data-import-processing-core

Description: The library to handle events from data-import

Core infrastructure for event processing for the DataImport.

GitHub README: https://github.com/folio-org/data-import-processing-core

data-import-utils

Description: Library with common utilities for data-import modules

Utilities for DataImport modules.

GitHub README: https://github.com/folio-org/data-import-utils

docs

Description: FOLIO Documentation

This is the documentation for FOLIO apps. If working with this Hugo site locally, be sure to execute git submodule update --init --recursive before attempting to build with Hugo for the first time.

GitHub README: https://github.com/folio-org/docs

eslint-config-stripes

Description: Stripes's .eslintrc as an extensible shared config

GitHub README: https://github.com/folio-org/eslint-config-stripes

folio-analytics

Description: FOLIO reports and analytics

This repository contains reports and other analytics developed for FOLIO and designed to run on the Library Data Platform. At present most of the content here consists of SQL reports developed by the FOLIO reporting community and based on the requirements of FOLIO partner libraries. For more information about FOLIO reporting, see the FOLIO Reporting Special Interest Group.

GitHub README: https://github.com/folio-org/folio-analytics

folio-ansible

Description: Ansible playbook for FOLIO

GitHub README: https://github.com/folio-org/folio-ansible

GitHub other documentation: https://github.com/folio-org/folio-ansible/tree/master/doc

folio-api-tests

Description: FOLIO postman collections for backend modules

GitHub README: https://github.com/folio-org/folio-api-tests

folio-custom-fields

Description: Store and maintain custom fields

The FOLIO module to store and maintain custom fields. The folio-custom-fields is designed to be a library that any module can add and use to store custom fields definitions as well as their values.

GitHub README: https://github.com/folio-org/folio-custom-fields

folio-di-support

Description: Dependency Injection support for FOLIO backend modules

Dependency Injection support for FOLIO backend modules

GitHub README: https://github.com/folio-org/folio-di-support

folio-graphiql

Description: Serves up GraphiQL for use with FOLIO

GitHub README: https://github.com/folio-org/folio-graphiql

folio-helm

Description: Helm charts modules repository

FOLIO Helm charts modules repository.

GitHub README: https://github.com/folio-org/folio-helm

folio-holdingsiq-client

Description: Client library to HoldingsIQ API

This is a client library to RM API

GitHub README: https://github.com/folio-org/folio-holdingsiq-client

folio-install

Description: Runbooks for FOLIO installation

A collection of runbooks for FOLIO installation.

GitHub README: https://github.com/folio-org/folio-install

folio-integration-tests

Description: The set of integration tests, based on karate framework

This project is the set of integration tests based on karate framework

GitHub README: https://github.com/folio-org/folio-integration-tests

folio-isbn-util

Description: ISBN number converter utilities

ISBN number converter utilities.

GitHub README: https://github.com/folio-org/folio-isbn-util

folio-liquibase-util

Description: Liquibase utilities

Liquibase schema migration utilities.

GitHub README: https://github.com/folio-org/folio-liquibase-util

folio-org.github.io

Description: Website for FOLIO open source development dev.folio.org

GitHub README: https://github.com/folio-org/folio-org.github.io

folio-perf-test

Description: Jenkins pipelines to test FOLIO performance and integration

GitHub README: https://github.com/folio-org/folio-perf-test

folio-sample-modules

Description: Examples of FOLIO modules

This project contains examples of FOLIO modules (currently a server-side Vert.x-based module, but more, e.g. a UI/front-end module will come later), and some general information about writing, packaging and describing modules.

GitHub README: https://github.com/folio-org/folio-sample-modules

GitHub other documentation: https://github.com/folio-org/folio-sample-modules/tree/master/doc

folio-service-tools

Description: Library with general purpose classes to help with FOLIO backend service development

Library with general purpose classes to help with FOLIO backend service development and testing

GitHub README: https://github.com/folio-org/folio-service-tools

folio-test-env

Description: [Not provided]

Basic instructions and bootstrap files for setting up a test instance of FOLIO.

GitHub README: https://github.com/folio-org/folio-test-env

folio-testing-platform

Description: [Not provided]

GitHub README: https://github.com/folio-org/folio-testing-platform

folio-tools

Description: Various tools and support glue for FOLIO CI

GitHub README: https://github.com/folio-org/folio-tools

generate-marc-utils

Description: Shared library for generating MARC records on-the-fly

Shared library for generating MARC records on-the-fly

GitHub README: https://github.com/folio-org/generate-marc-utils

inventory-sample-data

Description: [Not provided]

GitHub README: https://github.com/folio-org/inventory-sample-data

J-R

jenkins-pipeline-libs

Description: Shared library for Jenkins Pipeline

GitHub README: https://github.com/folio-org/jenkins-pipeline-libs

mod-rmb-template

Description: Maven archetype used to generate an RMB-based module

This is a Maven archetype used to generate an RMB-based server-side module. Install this locally if you wish to build such a module.

GitHub README: https://github.com/folio-org/mod-rmb-template

Net-Z3950-FOLIO

Description: A Z39.50 server for FOLIO bibliographic data

z2folio is a Z39.50 server for FOLIO bibliographic and holdings data, supporting record retrieval in USMARC, OPAC, XML and JSON formats. The functionality is all provided by the Net::Z3950::FOLIO library, which is also part of this distribution. It is written in Perl, and follows standard Perl-module conventions.

GitHub README: https://github.com/folio-org/Net-Z3950-FOLIO

GitHub other documentation: https://github.com/folio-org/Net-Z3950-FOLIO/tree/master/doc

okapi-cli

Description: Okapi command-line interface

Okapi command-line interface (yet another one)

GitHub README: https://github.com/folio-org/okapi-cli

okapi-debian

Description: Experimental Debian Packaging Repo for Okapi

GitHub README: https://github.com/folio-org/okapi-debian

GitHub other documentation: https://github.com/folio-org/okapi-debian/tree/master/doc

perf-testing

Description: Repository that houses tools and performance testing scripts

Carrier is an open source continuous performance testing toolkit. It consists of tools and practices to integrate non-functional tests into delivery pipeline and organize effective feedback loop.

GitHub README: https://github.com/folio-org/perf-testing

personal-data-disclosure

Description: The personal data disclosure form template and related tools/scripts

The purpose of this repository is to provide a personal data disclosure form template and related tools/scripts. Each module will specialize and store this form in the top level of their git repository. The form is a mechanism to disclose the types of personal data stored by each module. This information enables those hosting FOLIO to better manage and comply with various privacy laws and restrictions, e.g. GDPR, etc.

GitHub README: https://github.com/folio-org/personal-data-disclosure

reporting-erm-doc

Description: ERM schema documentation

GitHub README: https://github.com/folio-org/reporting-erm-doc

rfcs

Description: RFCs for changes to the FOLIO platform

  • Folio RFCs are stored as MarkDown documents as part of the GitHub RFC Repo.

GitHub README: https://github.com/folio-org/rfcs

S-Z

spring-module-core

Description: Spring module core libraries for Spring development with Okapi

Spring module core libraries for Spring development with Okapi.

GitHub README: https://github.com/folio-org/spring-module-core

ui-app-template

Description: Stripes UI app module template

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run uiAppName and start your development.

GitHub README: https://github.com/folio-org/ui-app-template

yakbak-proxy

Description: Yakbak proxy for reading/writing tapes of network interactions

yakbak-proxy is a simple Web proxy implemented using yakbak. It accepts incoming HTTP connections and proxies them through the nominated server, keeping a record ('tapes') of all requests and their corresponding responses. Then later you can run the same client against the same proxy server, and it will re-use the tapes. This is especially useful for testing a Web UI away from its corresponding back-end.

GitHub README: https://github.com/folio-org/yakbak-proxy

Usage notes

Mainline branch information

The links are to current main branches of each repository, thereby reflecting the current state of development.

So for specific module releases, the GitHub URLs need to be be adjusted to the relevant release “tag”. Use the “Branches/Tags” menu at the left-hand of its breadcrumb trail.

DB schema

If a “DB schema” link is shown, then use this to assist construction of CQL search queries.

It shows which tables are available, the database indexes and their types (e.g. fullTextIndex, uniqueIndex, etc.) along with details of those indexes (e.g. caseSensitive, removeAccents, etc.).

Further information

Refer to tips for module developers to increase visibility of module documentation.

Explanation about how this map is assembled and maintained.