Introduction
List of FOLIO modules hosted at GitHub, with links to some related documentation. Also refer to the Source-code overview.
Last gathered date: 30 November 2023 (271 repositories). See usage notes below.
Frontend ui repos
57 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://docs.folio.org/docs/settings/settings_acquisition_units/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 settings: https://docs.folio.org/docs/settings/settings_agreements/settings_agreements/
User docs: https://poppy.docs.folio.org/docs/erm/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-bulk-edit
Description: [Not provided]
Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-bulk-edit and start your development.
GitHub README: https://github.com/folio-org/ui-bulk-edit
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://docs.folio.org/docs/settings/settings_calendar/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
User docs: https://poppy.docs.folio.org/docs/access/check-in/checkin/
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
User docs: https://poppy.docs.folio.org/docs/access/check-out/checkout/
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://docs.folio.org/docs/settings/settings_circulation/settings_circulation/
User docs: https://poppy.docs.folio.org/docs/access/
Other documentation:
https://wiki.folio.org/display/FOLIOtips/Example+Circulation+Rules+from+Adopters
https://docs.folio.org/docs/access/additional-topics/feesfines/feesfines/
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
User docs: https://poppy.docs.folio.org/docs/access/circulation-log/circ_log/
ui-consortia-settings
Description: Consortia settings
The ui-consortia-settings repo is used for the management of consortia settings in FOLIO.
GitHub README: https://github.com/folio-org/ui-consortia-settings
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 settings: https://docs.folio.org/docs/settings/settings_courses/settings_courses/
User docs: https://poppy.docs.folio.org/docs/access/courses/courses/
ui-dashboard
Description: A stripes app to display/customise FOLIO widgets
GitHub README: https://github.com/folio-org/ui-dashboard
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://docs.folio.org/docs/settings/settings_data_export/settings_data_export/
User docs: https://poppy.docs.folio.org/docs/metadata/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://docs.folio.org/docs/settings/settings_data_import/settings_data_import/
User docs: https://poppy.docs.folio.org/docs/metadata/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
ui-directory
Description: UI component for directory app in an OKAPI environment
Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-directory and start your development.
GitHub README: https://github.com/openlibraryenvironment/ui-directory
GitHub other documentation: https://github.com/openlibraryenvironment/ui-directory/tree/master/doc
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 settings: https://docs.folio.org/docs/settings/settings_eholdings/settings_eholdings/
User docs: https://poppy.docs.folio.org/docs/erm/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. Funded by European Regional Development Fund (EFRE).
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
User docs: https://poppy.docs.folio.org/docs/erm/eusage/
Other documentation:
https://wiki.folio.org/display/ERMSIG/eUsage+documentation
ui-export-manager
Description: [Not provided]
GitHub README: https://github.com/folio-org/ui-export-manager
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 settings: https://docs.folio.org/docs/settings/settings_finance/settings_finance/
User docs: https://poppy.docs.folio.org/docs/acquisitions/finance/
ui-finc-config
Description: UI finc-config module. Funded by European Regional Development Fund (EFRE).
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. Funded by European Regional Development Fund (EFRE).
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-gobi-settings
Description: Stripes UI module: managing GOBI settings
The ui-gobi-settings repo is used for the management of GOBI integration settings in FOLIO.
GitHub README: https://github.com/folio-org/ui-gobi-settings
ui-idm-connect
Description: Stripes UI for managing UB Leipzig users and contracts. Funded by European Regional Development Fund (EFRE).
Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-idm-connect and start your development.
GitHub README: https://github.com/folio-org/ui-idm-connect
ui-inn-reach
Description: [Not provided]
Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-inn-reach and start your development.
GitHub README: https://github.com/folio-org/ui-inn-reach
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://docs.folio.org/docs/settings/settings_inventory/settings_inventory/
User docs: https://poppy.docs.folio.org/docs/metadata/inventory/
Other documentation:
https://wiki.folio.org/display/FOLIOtips/Single+Record+Import
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 settings: https://docs.folio.org/docs/settings/settings_invoices/settings_invoices/
User docs: https://poppy.docs.folio.org/docs/acquisitions/invoices/
J-R
ui-ldp
Description: Reporting Front End module
LDP query builder UI for FOLIO/ReShare.
GitHub README: https://github.com/folio-org/ui-ldp
GitHub other documentation: https://github.com/folio-org/ui-ldp/tree/master/doc
User docs: https://poppy.docs.folio.org/docs/reporting/
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 settings: https://docs.folio.org/docs/settings/settings_licenses/settings_licenses/
User docs: https://poppy.docs.folio.org/docs/erm/licenses/
ui-lists
Description: [Not provided]
The Lists UI Module, or ui-lists, is a Stripes UI Module used to create and manage Lists which are queries across multiple modules (for example: find all items marked as missing or declared lost, or find all open loans assigned to inactive users).
GitHub README: https://github.com/folio-org/ui-lists
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 settings: https://wiki.folio.org/display/FOLIOtips/Settings+-+Local+KB+admin
User docs: https://poppy.docs.folio.org/docs/erm/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
App tips: https://wiki.folio.org/display/FOLIOtips/Course+Reserves+-+LTI+connectivity
User docs: https://poppy.docs.folio.org/docs/access/courses/courses/
ui-marc-authorities
Description: MARC Authorities module
This is a UI module for administrating authority records.
GitHub README: https://github.com/folio-org/ui-marc-authorities
User docs: https://poppy.docs.folio.org/docs/metadata/inventory/marcauthority/
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
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://docs.folio.org/docs/settings/settings_notes/settings_notes/
ui-oa
Description: UX module for Open Access Management
The Open Access UI Module or ui-oa, is a Stripes UI module for the management of OA publication requests and related resources
GitHub README: https://github.com/folio-org/ui-oa
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
App settings: https://docs.folio.org/docs/settings/settings_oaipmh/settings_oaipmh/
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 settings: https://docs.folio.org/docs/settings/settings_orders/settings_orders/
User docs: https://poppy.docs.folio.org/docs/acquisitions/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 settings: https://docs.folio.org/docs/settings/settings_organizations/settings_organizations/
User docs: https://poppy.docs.folio.org/docs/acquisitions/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
User docs: https://poppy.docs.folio.org/docs/metadata/inventory/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
User docs: https://poppy.docs.folio.org/docs/acquisitions/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
App settings: https://docs.folio.org/docs/settings/settings_remotestorage/remotestorage/
ui-remote-sync
Description: Exploratory Front End App : support systems librarians syncing data from external data sources
GitHub README: https://github.com/folio-org/ui-remote-sync
ui-request
Description: Request resources for ILL
GitHub README: https://github.com/openlibraryenvironment/ui-request
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
User docs: https://poppy.docs.folio.org/docs/access/requests/requests/
ui-rs
Description: STRIPES app providing front end for resource sharing
Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-rs and start your development.
GitHub README: https://github.com/openlibraryenvironment/ui-rs
S-Z
ui-serials-management
Description: UX Module for Serials Management
The Serials Management UI Module or ui-serials-management, is a Stripes UI module for the management of serials, alongside expected pieces and prediction patterns
GitHub README: https://github.com/folio-org/ui-serials-management
ui-service-interaction
Description: [Not provided]
FOLIO UI Module for service-interaction
GitHub README: https://github.com/folio-org/ui-service-interaction
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-supply
Description: ReShare app to supply resources for ILL
GitHub README: https://github.com/openlibraryenvironment/ui-supply
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://docs.folio.org/docs/settings/settings_tags/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-translations
Description: FOLIO Translations Management App
Each FOLIO installation has lists of controlled vocabulary terms (for instance, “Formats” and “Resource types” in Inventory, “Patron Groups” and “Refund Reasons” in Users — see FOLIO-2802 for a more complete list). In installations that use more than one language, these terms do not display translated values when the locale of the session is changed.
So we need a mechanism for translating and managing the translations of the controlled vocabulary terms in the Settings app and all stripes apps that contain controlled vocabularies so that translators can perform the translation work of the controlled vocabulary terms.
GitHub README: https://github.com/folio-org/ui-translations
ui-update
Description: Update app, part of the UI for the ReShare project
Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-scan and start your development.
GitHub README: https://github.com/openlibraryenvironment/ui-update
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 settings: https://docs.folio.org/docs/settings/settings_users/settings_users/
User docs: https://poppy.docs.folio.org/docs/users/
Frontend ui plugin repos
21 repositories.
A-N
ui-plugin-bursar-export
Description: [Not provided]
This package furnishes a single Stripes plugin of type bursar-export, which can be included in Stripes modules by means of a <Pluggable type='bursar-export'> element. See the Plugins section of the Module Developer's Guide.
GitHub README: https://github.com/folio-org/ui-plugin-bursar-export
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-eusage-reports
Description: Stripes plugin module for displaying graphs of eUsage
This package furnishes a single Stripes plugin of type eusage-reports, which can be included in Stripes modules by means of a <Pluggable type='eusage-reports'> element. See the Plugins section of the Module Developer's Guide.
GitHub README: https://github.com/folio-org/ui-plugin-eusage-reports
GitHub other documentation: https://github.com/folio-org/ui-plugin-eusage-reports/tree/master/doc
Other documentation:
https://wiki.folio.org/display/ERMSIG/eUsage+Reports+Documentation
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-authority
Description: Stripes plugin to find Authority records
This package furnishes a single Stripes plugin of type find-authority, which can be included in Stripes modules by means of a <Pluggable type='find-authority'> element. See the Plugins section of the Module Developer's Guide.
GitHub README: https://github.com/folio-org/ui-plugin-find-authority
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. Funded by European Regional Development Fund (EFRE).
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. Funded by European Regional Development Fund (EFRE).
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. Funded by European Regional Development Fund (EFRE).
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-fund
Description: Stripes UI plugin: Display, filter and select funds
This package furnishes a single Stripes plugin of type find-fund, which can be included in Stripes modules by means of a <Pluggable type='find-fund'> element. See the Plugins section of the Module Developer's Guide.
GitHub README: https://github.com/folio-org/ui-plugin-find-fund
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
O-Z
ui-plugin-query-builder
Description: [Not provided]
This package furnishes a single Stripes plugin of type query-builder, which can be included in Stripes modules by means of a <Pluggable type='query-builder'> element. See the Plugins section of the Module Developer's Guide.
GitHub README: https://github.com/folio-org/ui-plugin-query-builder
Frontend ui handler repos
1 repositories.
ui-handler-stripes-registry
Description: Frontend registry for Stripes
Frontend registry for Stripes
GitHub README: https://github.com/folio-org/ui-handler-stripes-registry
Stripes repos
25 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-authority-components
Description: Stripes components that are specific to use cases that arise in Authority-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-authority-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-component-number-generator
Description: A Number Generator UI Component
GitHub README: https://github.com/folio-org/stripes-component-number-generator
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
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
https://folio-org.github.io/stripes-components/
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-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-erm-testing
Description: A repository for shared testing config and components for the ERM suite of applications
GitHub README: https://github.com/folio-org/stripes-erm-testing
GitHub other documentation: https://github.com/folio-org/stripes-erm-testing/tree/master/docs
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-inventory-components
Description: Administer locally created instances, holdings records, items
This is a Stripes UI module for administrating locally created instances, holdings records and items.
GitHub README: https://github.com/folio-org/stripes-inventory-components
stripes-marc-components
Description: Stripes components that are specific to use cases that arise in Marc-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-marc-components
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-shared-context
Description: Shared React Context used in Federation setup
List of React global contexts used in Webpack federation.
GitHub README: https://github.com/folio-org/stripes-shared-context
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-types
Description: A set of TypeScript typings for the Stripes UI framework
This is a set of TypeScript typings for the Stripes UI framework.
GitHub README: https://github.com/folio-org/stripes-types
stripes-ui
Description: The UI wrapper for Stripes Modules
Stripes UI is a main wrapper responsible for setting the global layout of the user interface, such as the global navigation menu and top bar. It also renders given stripes module on the appropriate route.
GitHub README: https://github.com/folio-org/stripes-ui
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-vendor-dll
Description: Stripes Vendor Dll
Stripes Vendor Dll is a tool which can be used to create a DLL bundle. The bundle currently includes all 3rd party dependencies (react, moment, etc) found in stripes plus couple additional stripes dependencies (stripes-components, stripes-connect,stripes-logger,stripes-util).
GitHub README: https://github.com/folio-org/stripes-vendor-dll
stripes-webpack
Description: [Not provided]
Stripes Webpack contains webpack config files used for building and serving Folio bundles via stripes-cli.
GitHub README: https://github.com/folio-org/stripes-webpack
Stripes platform repos
4 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
GitHub other documentation: https://github.com/folio-org/platform-complete/tree/master/doc
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
platform-minimal
Description: Minimal set of back-end and front-end modules for FOLIO
This is the 'minimal' Stripes 'platform'. It consists simply of an NPM package.json that specifies the versions of @folio/stripes, @folio/stripes, the shared dependencies they rely on, and a utility for generating module descriptors for each Stripes module.
GitHub README: https://github.com/folio-org/platform-minimal
platform-rs
Description: Stripes platform for Resource Sharing App
This is the Resource Sharing Stripes 'platform'. It consists simply of an NPM package.json that specifies the version of @folio/stripes and of any Stripes modules you wish to make available as part of the Resource Sharing platform to generate client bundles along with a utility for generating module descriptors for each Stripes module.
GitHub README: https://github.com/openlibraryenvironment/platform-rs
Backend mod repos
88 repositories.
A-F
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-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
API documentation: https://dev.folio.org/reference/api/#mod-authtoken
mod-batch-print
Description: Batch printing service
mod-batch-print is a service to provide option to print notices in daily batch approach.
GitHub README: https://github.com/folio-org/mod-batch-print
API documentation: https://dev.folio.org/reference/api/#mod-batch-print
mod-bulk-operations
Description: [Not provided]
The purpose of this Bulk Operations (Edit/Delete) application is to modify and delete different entities in bulks.
GitHub README: https://github.com/folio-org/mod-bulk-operations
API documentation: https://dev.folio.org/reference/api/#mod-bulk-operations
mod-calendar
Description: Calendar functionalities to enable service points to maintain hours of operation
This module provides calendar functionalities for FOLIO systems, allowing service points to maintain hours of operation.
GitHub README: https://github.com/folio-org/mod-calendar
GitHub other documentation: https://github.com/folio-org/mod-calendar/tree/master/docs
API documentation: https://dev.folio.org/reference/api/#mod-calendar
mod-camunda
Description: [Not provided]
GitHub README: https://github.com/folio-org/mod-camunda
GitHub RAMLs directory: https://github.com/folio-org/mod-camunda/tree/master/ramls
API documentation: https://dev.folio.org/reference/api/#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
Other documentation:
https://github.com/folio-org/mod-circulation/blob/master/doc/circulationrules.md
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-item
Description: [Not provided]
This is the blueprint module that should be used as a template for FOLIO Spring-based backend modules. It provides the initial configuration and common data schemas used by the FOLIO platform.
GitHub README: https://github.com/folio-org/mod-circulation-item
API documentation: https://dev.folio.org/reference/api/#mod-circulation-item
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-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-consortia
Description: Consortia business logic module
APIs for Consortia module.
GitHub README: https://github.com/folio-org/mod-consortia
GitHub other documentation: https://github.com/folio-org/mod-consortia/tree/master/docs
API documentation: https://dev.folio.org/reference/api/#mod-consortia
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 can import records from remote systems using Z39.50 or a straight MARC record can be provided.
GitHub README: https://github.com/folio-org/mod-copycat
GitHub other documentation: https://github.com/folio-org/mod-copycat/tree/master/doc
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-export-spring
Description: [Not provided]
API for Data Export Spring module.
GitHub README: https://github.com/folio-org/mod-data-export-spring
API documentation: https://dev.folio.org/reference/api/#mod-data-export-spring
mod-data-export-worker
Description: [Not provided]
API for Data Export Worker module.
GitHub README: https://github.com/folio-org/mod-data-export-worker
API documentation: https://dev.folio.org/reference/api/#mod-data-export-worker
mod-data-import
Description: [Not provided]
mod-data-import is responsible for uploading files (see documentation for file uploading), initial handling and sending records for further processing (see documentation for file processing).
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-datasets
Description: Glint server module wrapper for FOLIO
GitHub README: https://github.com/folio-org/mod-datasets
mod-dcb
Description: [Not provided]
APIs for managing dcb transactions in folio.
GitHub README: https://github.com/folio-org/mod-dcb
API documentation: https://dev.folio.org/reference/api/#mod-dcb
mod-di-converter-storage
Description: Data import converter storage
Data Import Converter Storage.
GitHub README: https://github.com/folio-org/mod-di-converter-storage
GitHub RAMLs directory: https://github.com/folio-org/mod-di-converter-storage/tree/master/ramls
API documentation: https://dev.folio.org/reference/api/#mod-di-converter-storage
mod-directory
Description: Okapi module providing directory and locator services
Mod-Directory is a service intiailly proposed for use in resource sharing environments but offering services to any library scenario that involves documenting and using service interactions between peers. It's purpose is to provide a bounded context for the storage, retrieval and update of directory service information which underpins inter-library services. This directory contains, but is not restricted to
GitHub README: https://github.com/openlibraryenvironment/mod-directory
GitHub other documentation: https://github.com/openlibraryenvironment/mod-directory/tree/main/doc
GitHub RAMLs directory: https://github.com/openlibraryenvironment/mod-directory/tree/main/ramls
mod-ebsconet
Description: [Not provided]
Backend module for integration with Ebsconet external systems
GitHub README: https://github.com/folio-org/mod-ebsconet
API documentation: https://dev.folio.org/reference/api/#mod-ebsconet
mod-email
Description: Provides functionality for sending notifications
mod-email provides an API for delivering email messages.
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-entities-links
Description: [Not provided]
This module provides a storing and processing functionality for links between entities.
GitHub README: https://github.com/folio-org/mod-entities-links
GitHub other documentation: https://github.com/folio-org/mod-entities-links/tree/master/doc
API documentation: https://dev.folio.org/reference/api/#mod-entities-links
mod-erm-usage
Description: Store ERM usage statistics and access data to these statistics. Funded by European Regional Development Fund (EFRE).
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. Funded by European Regional Development Fund (EFRE).
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. Funded by European Regional Development Fund (EFRE).
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-eusage-reports
Description: Parsing and storing relationships between COUNTER report lines and KB items, and for storing access statistics (access numbers and cost) for specific periods
mod-eusage-reports is a backend module for parsing and storing relationships between COUNTER report lines and KB items, and for storing access statistics (access numbers and cost) for specific periods.
GitHub README: https://github.com/folio-org/mod-eusage-reports
GitHub other documentation: https://github.com/folio-org/mod-eusage-reports/tree/master/doc
API documentation: https://dev.folio.org/reference/api/#mod-eusage-reports
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
Other documentation:
https://docs.folio.org/docs/access/additional-topics/feesfines/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. Funded by European Regional Development Fund (EFRE).
Backend module for both ui-finc-config and ui-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
mod-fqm-manager
Description: FOLIO Query Machine back-end module
FQM (FOLIO query machine) is the engine that takes in queries, processes queries, and provides answers. FQM consolidates data from different modules within FOLIO in real time, allowing users to conduct cross-application searches efficiently.
GitHub README: https://github.com/folio-org/mod-fqm-manager
API documentation: https://dev.folio.org/reference/api/#mod-fqm-manager
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-idm-connect
Description: Manage walk-in contracts. Funded by European Regional Development Fund (EFRE).
The module manages walk-in contracts. It is tailored to the specific requirements at Leipzig University Library. You may not find this module useful in different environments.
GitHub README: https://github.com/folio-org/mod-idm-connect
GitHub DB schema: https://github.com/folio-org/mod-idm-connect/blob/master/src/main/resources/templates/db_scripts/schema.json
GitHub RAMLs directory: https://github.com/folio-org/mod-idm-connect/tree/master/ramls
API documentation: https://dev.folio.org/reference/api/#mod-idm-connect
mod-inn-reach
Description: Implements INN-Reach service client
The module provides an access to INN-Reach.
GitHub README: https://github.com/folio-org/mod-inn-reach
API documentation: https://dev.folio.org/reference/api/#mod-inn-reach
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 (MIU) 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-ldp
Description: Reporting Back End module
mod-ldp is a FOLIO module that mediates access to the Library Data Platform (LDP). It removes the need to deal directly with a relational database by providing a simple WSAPI that can be used by UI code such as ui-ldp.
GitHub README: https://github.com/folio-org/mod-ldp
GitHub other documentation: https://github.com/folio-org/mod-ldp/tree/master/doc
GitHub RAMLs directory: https://github.com/folio-org/mod-ldp/tree/master/ramls
API documentation: https://dev.folio.org/reference/api/#mod-ldp
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-lists
Description: Lists back-end module
mod-lists is responsible for persisting the metadata and the contents (IDs) of lists.
GitHub README: https://github.com/folio-org/mod-lists
API documentation: https://dev.folio.org/reference/api/#mod-lists
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-marc-migrations
Description: Module designed for high-performance migration of MARC records.
GitHub README: https://github.com/folio-org/mod-marc-migrations
API documentation: https://dev.folio.org/reference/api/#mod-marc-migrations
mod-metadb-storage
Description: Thin wrapper for Metadb server
GitHub README: https://github.com/folio-org/mod-metadb-storage
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 other documentation: https://github.com/folio-org/mod-notes/tree/master/docs
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-oa
Description: Bounded Context Deailing with Open Access Publishing
Bounded Context Deailing with Open Access Publishing
GitHub README: https://github.com/folio-org/mod-oa
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 DB schema: https://github.com/folio-org/mod-orders/blob/master/src/main/resources/templates/db_scripts/schema.json
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 other documentation: https://github.com/folio-org/mod-password-validator/tree/master/doc
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
Spring-based module that provides API for quickMARC - in-app editor for MARC records in SRS.
GitHub README: https://github.com/folio-org/mod-quick-marc
GitHub other documentation: https://github.com/folio-org/mod-quick-marc/tree/master/doc
API documentation: https://dev.folio.org/reference/api/#mod-quick-marc
mod-remote-storage
Description: Backend module for remote storage.
Backend module for remote storages
GitHub README: https://github.com/folio-org/mod-remote-storage
API documentation: https://dev.folio.org/reference/api/#mod-remote-storage
mod-remote-sync
Description: Pluggable data synchronisation with arbitrary sources - initially focussed on LASER resources into Subscriptions and Agreements. Funded by European Regional Development Fund (EFRE)
GitHub README: https://github.com/folio-org/mod-remote-sync
mod-reservoir
Description: A service that provides a clustering storage of metadata for Data Integration purposes
A service that provides a clustering storage of metadata for Data Integration purposes. Optimized for fast storage and retrieval performance.
GitHub README: https://github.com/folio-org/mod-reservoir
API documentation: https://dev.folio.org/reference/api/#mod-reservoir
mod-rs
Description: Module providing Resource Sharing services to an OKAPI environment
GitHub README: https://github.com/openlibraryenvironment/mod-rs
GitHub other documentation: https://github.com/openlibraryenvironment/mod-rs/tree/master/doc
GitHub RAMLs directory: https://github.com/openlibraryenvironment/mod-rs/tree/master/ramls
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-search
Description: [Not provided]
This module provides a search functionality for instance and authorities via REST API. It uses The Contextual Query Language as a formal language to query records using filters, boolean conditions, etc.
GitHub README: https://github.com/folio-org/mod-search
GitHub other documentation: https://github.com/folio-org/mod-search/tree/master/doc
Other documentation:
https://github.com/folio-org/mod-search/blob/master/doc/development.md
API documentation: https://dev.folio.org/reference/api/#mod-search
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-serials-management
Description: FOLIO Backend module for Serials Management
FOLIO Backend module for Serials Management
GitHub README: https://github.com/folio-org/mod-serials-management
mod-service-interaction
Description: FOLIO Backend Module for cross-app connectivity
Mod-Service-Interaction is a FOLIO Backend Module for cross-app connectivity.
GitHub README: https://github.com/folio-org/mod-service-interaction
mod-settings
Description: Secure global and per-user settings for FOLIO
mod-settings is a key-value store that provides a more secure configuration system than the old mod-configuration.
GitHub README: https://github.com/folio-org/mod-settings
GitHub other documentation: https://github.com/folio-org/mod-settings/tree/master/doc
API documentation: https://dev.folio.org/reference/api/#mod-settings
mod-source-record-manager
Description: [Not provided]
FOLIO source record manager module.
GitHub README: https://github.com/folio-org/mod-source-record-manager
Other documentation:
https://github.com/folio-org/mod-source-record-manager/tree/master/mod-source-record-manager-server/src/main/resources/rules
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-spring-template
Description: The blueprint module that could be used as a template for folio spring based backend modules.
This is the blueprint module that should be used as a template for FOLIO Spring-based backend modules. It provides the initial configuration and common data schemas used by the FOLIO platform.
GitHub README: https://github.com/folio-org/mod-spring-template
API documentation: https://dev.folio.org/reference/api/#mod-spring-template
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 other documentation: https://github.com/folio-org/mod-tags/tree/master/doc
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-translations
Description: FOLIO Translations Management API
Each FOLIO installation has lists of controlled vocabulary terms (for instance, “Formats” and “Resource types” in Inventory, “Patron Groups” and “Refund Reasons” in Users — see FOLIO-2802 for a more complete list). In installations that use more than one language, these terms do not display translated values when the locale of the session is changed.
GitHub README: https://github.com/folio-org/mod-translations
mod-user-import
Description: Import new or already existing users
This module is responsible for importing new or already existing users into FOLIO.
GitHub README: https://github.com/folio-org/mod-user-import
Other documentation:
https://wiki.folio.org/display/FOLIOtips/Creating+Staff+Users+with+Service+Points%2C+Permissions+and+Passwords+using+API+calls
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
18 repositories.
edge-api-utils
Description: [Not provided]
The purpose of this edge API utils is the combine classes/utilities/constants shared by both modules: edge-common and edge-common-spring.
GitHub README: https://github.com/folio-org/edge-api-utils
edge-caiasoft
Description: Bridge the gap between CaiaSoft remote storage provider and FOLIO
The purpose of this edge API is to bridge the gap between CaiaSoft remote storage provider and FOLIO.
GitHub README: https://github.com/folio-org/edge-caiasoft
API documentation: https://dev.folio.org/reference/api/#edge-caiasoft
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-common-spring
Description: A shared library/framework for edge APIs for spring way modules
This is a shared library/framework for edge APIs for spring way modules. This module is a port of edge-common, and main goal is feature parity with that framework. From a hosting/SysOps perspective, edge modules developed with this framework should be indistinguishable from those developed using edge-common.
GitHub README: https://github.com/folio-org/edge-common-spring
edge-connexion
Description: Integrate a direct single record import via OCLC Connexion
edge-connexion is a FOLIO module for importing records to a FOLIO instance via OCLC Connexion
GitHub README: https://github.com/folio-org/edge-connexion
edge-courses
Description: Edge API is to bridge the gap between 3rd party discovery services and FOLIO mod-courses module.
Provides an ability to retrieve course-reserve information from FOLIO
GitHub README: https://github.com/folio-org/edge-courses
API documentation: https://dev.folio.org/reference/api/#edge-courses
edge-dcb
Description: [Not provided]
The purpose of this edge API is to bridge the gap between DCB provider and FOLIO.
GitHub README: https://github.com/folio-org/edge-dcb
API documentation: https://dev.folio.org/reference/api/#edge-dcb
edge-dematic
Description: Bridge the gap between Dematic remote storage provider and FOLIO
The purpose of this edge API is to bridge the gap between Dematic remote storage provider and FOLIO.
GitHub README: https://github.com/folio-org/edge-dematic
API documentation: https://dev.folio.org/reference/api/#edge-dematic
edge-fqm
Description: [Not provided]
Provides an ability to retrieve query and entity type information from FOLIO
GitHub README: https://github.com/folio-org/edge-fqm
API documentation: https://dev.folio.org/reference/api/#edge-fqm
edge-inn-reach
Description: A Spring based shared library/framework for edge APIs to INN-REACH system.
A Spring based shared library/framework for edge APIs to INN-REACH system.
GitHub README: https://github.com/folio-org/edge-inn-reach
API documentation: https://dev.folio.org/reference/api/#edge-inn-reach
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 other documentation: https://github.com/folio-org/edge-lti-courses/tree/master/docs
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-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-search-srs
Description: [Not provided]
Microservice provides wide-search capabilities of marc records in the mod-source-record-storage(SRS) for 3rd party discovery services
GitHub README: https://github.com/folio-org/edge-search-srs
API documentation: https://dev.folio.org/reference/api/#edge-search-srs
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 API repos
8 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
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-export-common
Description: The common resources library for mod-data-export-spring and mod-data-export-worker
This is the central repository for the models for mod-data-export-spring and mod-data-export-worker modules.
GitHub README: https://github.com/folio-org/folio-export-common
folio-query-tool-metadata
Description: [Not provided]
folio-query-tool-metadata is responsible for defining the API for the mod-fqm-manager and edge-fqm modules, including the object models that are part of that API.
GitHub README: https://github.com/folio-org/folio-query-tool-metadata
API documentation: https://dev.folio.org/reference/api/#folio-query-tool-metadata
folio-spring-support
Description: This is a library (jar) that contains the basic functionality and main dependencies required for development FOLIO modules using Spring framework.
This is a library that contains the basic functionality and main dependencies required for development of FOLIO modules using Spring framework (also known as 'Spring Way').
GitHub README: https://github.com/folio-org/folio-spring-support
GitHub other documentation: https://github.com/folio-org/folio-spring-support/tree/master/doc
API documentation: https://dev.folio.org/reference/api/#folio-spring-support
folio-vertx-lib
Description: Lightweight FOLIO module development library for Vert.x that supports OpenAPI
folio-vertx-lib is a library for developing FOLIO modules based on Vert.x. This is a library, not a framework, with utilities such as:
GitHub README: https://github.com/folio-org/folio-vertx-lib
API documentation: https://dev.folio.org/reference/api/#folio-vertx-lib
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
47 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
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: Community query repository for FOLIO analytics based on Metadb/LDP
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. In addition to report development, FOLIO has a Reporting Special Interest Group that discusses reporting requirements and other related topics.
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-core-schema
Description: Core OpenApi FOLIO schema
GitHub README: https://github.com/folio-org/folio-core-schema
API documentation: https://dev.folio.org/reference/api/#folio-core-schema
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-helm-v2
Description: Helm charts modules repository (using Helm common library)
FOLIO Helm charts modules repository.
GitHub README: https://github.com/folio-org/folio-helm-v2
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-kafka-wrapper
Description: Library with transport layer's utilities for interaction with Kafka
Utilities for data import modules interaction with Kafka
GitHub README: https://github.com/folio-org/folio-kafka-wrapper
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-reporting
Description: Non-LDP reporting solution for FOLIO
GitHub README: https://github.com/bywatersolutions/folio-reporting
folio-s3-client
Description: S3-client for FOLIO modules
This is a shared library for FOLIO S3-client.
GitHub README: https://github.com/folio-org/folio-s3-client
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-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
greenmail-helm
Description: helm chart to greenmail
GitHub README: https://github.com/folio-org/greenmail-helm
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
jest-config-stripes
Description: The shared jest configuration for stripes applications and extensions
GitHub README: https://github.com/folio-org/jest-config-stripes
ldlite
Description: LDLite is a client-side reporting tool for Okapi-based services
GitHub README: https://github.com/library-data-platform/ldlite
ldp
Description: Provides an analytics capability for FOLIO libraries
GitHub README: https://github.com/library-data-platform/ldp
GitHub other documentation: https://github.com/library-data-platform/ldp/tree/main/doc
lib-fqm-query-processor
Description: [Not provided]
GitHub README: https://github.com/folio-org/lib-fqm-query-processor
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
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
pipelines-shared-library
Description: [Not provided]
GitHub README: https://github.com/folio-org/pipelines-shared-library
pokapi
Description: Simple Python object-oriented interface for getting records from FOLIO
The FOLIO platform is a library services platform. The Caltech Library uses a hosted solution by EBSCO for its library catalog. To make writing interfaces and automation scripts in Python easier, the Caltech Library Digital Library Development team are developing Pokapi (Python Okapi Interface), a Python package that provides an object-oriented interface to accessing FOLIO data via the Okapi API. It currently provides a simple object structure based mostly on FOLIO instance records.
GitHub README: https://github.com/caltechlibrary/pokapi
psql-dump-helm
Description: [Not provided]
GitHub README: https://github.com/folio-org/psql-dump-helm
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
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 FOLIO.
GitHub README: https://github.com/folio-org/spring-module-core
tech-council
Description: FOLIO Technical Council Documents
GitHub README: https://github.com/folio-org/tech-council
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.
For additional modules that are hosted at other GitHub organizations, see explanation of how to be included in the listing.