Skip FOLIO Project Navigation

Introduction

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

Last gathered date: 23 October 2020 (192 repositories).

Frontend ui repos

39 repositories.

A-I

ui-acquisition-units

Description: Stripes UI module: Management of Acquisition unit records

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

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

ui-agreements

Description: Stripes front end module for ERM module

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

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

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

ui-audit

Description: Stripes UI module: Viewing audit trails

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

ui-calendar

Description: FOLIO institutional calendar UI module

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

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

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

ui-checkin

Description: Stripes UI for checking in items with simulated scans

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

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

ui-checkout

Description: Stripes UI for checking out items with simulated scans

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

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

ui-circulation

Description: [Not provided]

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

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

ui-circulation-log

Description: [Not provided]

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

ui-courses

Description: Course reserves UI for FOLIO

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

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

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

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

ui-data-export

Description: UI module: data export managing

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

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

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

ui-data-import

Description: UI module: managing batch loader feature

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

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

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

ui-datasets

Description: [Not provided]

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

ui-developer

Description: Stripes UI module: developer facilities

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

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

ui-eholdings

Description: FOLIO eholdings App

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

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

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

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

ui-erm-comparisons

Description: Stripes App for ERM Comparison

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

ui-erm-usage

Description: Stripes UI for managing ERM usage statistics

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

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

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

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

ui-finance

Description: [Not provided]

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

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

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

ui-finc-config

Description: UI finc-config module

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

ui-finc-select

Description: finc-select UI module

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

ui-inventory

Description: UI module for administrating instances

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

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

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

ui-invoice

Description: [Not provided]

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

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

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

J-R

ui-licenses

Description: FOLIO front end module for licenses

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

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

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

ui-local-kb-admin

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

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

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

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

ui-lti-courses

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

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

ui-marccat

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

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

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

ui-myprofile

Description: UI module: managing user profile settings

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

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

ui-notes

Description: FOLIO Notes Helper App

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

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

ui-oai-pmh

Description: Stripes UI for oai-pmh

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

ui-orders

Description: [Not provided]

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

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

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

ui-organizations

Description: UI module for managing organization records

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

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

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

ui-quick-marc

Description: Stripes UI for quickMARC editor

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

ui-receiving

Description: [Not provided]

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

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

ui-remote-storage

Description: [Not provided]

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

ui-requests

Description: Stripes UI module for making requests on items

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

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

S-Z

Description: [Not provided]

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

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

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

ui-servicepoints

Description: Service Points handler module for Stripes

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

ui-tags

Description: UI module for managing tag settings

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

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

ui-tenant-settings

Description: Stripes UI module: managing tenant settings

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

ui-users

Description: Stripes UI module: administrating users

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

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

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

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

Frontend ui plugin repos

17 repositories.

A-N

ui-plugin-create-inventory-records

Description: [Not provided]

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

ui-plugin-create-item

Description: Stripes UI plugin: Create item

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

ui-plugin-example

Description: A Stripes UI plugin for editing markdown

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

ui-plugin-find-agreement

Description: ERM-agreement-finder plugin for Stripes

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

ui-plugin-find-contact

Description: Stripes UI plugin: Find a contact

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

ui-plugin-find-eresource

Description: ERM-eresource-finder plugin for Stripes

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

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

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

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

ui-plugin-find-import-profile

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

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

ui-plugin-find-instance

Description: Instance-finder plugin for Stripes

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

ui-plugin-find-interface

Description: Stripes UI plugin: Find an interface

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

ui-plugin-find-license

Description: UI Widget to lookup or create licenses

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

ui-plugin-find-organization

Description: Organization-finder plugin for Stripes

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

ui-plugin-find-package-title

Description: Stripes plugin to find packages and titles

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

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

ui-plugin-find-user

Description: User-finder plugin for Stripes

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

Stripes repos

16 repositories.

A-N

O-Z

stripes

Description: UI framework for building front-end FOLIO modules

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

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

stripes-cli

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

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

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

stripes-components

Description: A component library for Stripes

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

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

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

stripes-connect

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

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

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

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

stripes-demo-platform

Description: Stripes platform for building the demo site

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

stripes-erm-components

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

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

stripes-final-form

Description: A Final Form Wrapper for Stripes

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

stripes-form

Description: A redux-form wrapper for Stripes

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

stripes-sample-platform

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

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

stripes-smart-components

Description: [Not provided]

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]

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

stripes-testing

Description: [Not provided]

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

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

stripes-util

Description: A library of utility functions to support Stripes modules

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

Stripes platform repos

3 repositories.

platform-complete

Description: Complete set of Stripes modules for FOLIO

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

platform-core

Description: Core set of Stripes modules for FOLIO

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

platform-erm

Description: FOLIO Stripes platform for ERM modules

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

Backend mod repos

67 repositories.

A-F

mod-aes

Description: Provide asynchronous event service (AES)

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

mod-agreements

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

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

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

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

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

mod-audit-filter

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

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

mod-authtoken

Description: Module for filtering requests based on JWT tokens

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

mod-calendar

Description: [Not provided]

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

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

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

mod-camunda

Description: [Not provided]

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

mod-circulation

Description: FOLIO mod-circulation

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

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

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

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

mod-circulation-storage

Description: FOLIO mod-circulation-storage

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

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

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

mod-codex-ekb

Description: [Not provided]

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

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

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

mod-codex-inventory

Description: Codex wrapper for local inventory

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

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

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

mod-codex-mock

Description: Codex mock module - for testing and development

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

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

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

mod-codex-mux

Description: Codex Multiplexer backend module

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

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

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

mod-configuration

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

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

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

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

mod-courses

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

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

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

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

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

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

mod-data-import

Description: [Not provided]

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

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

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

mod-data-import-converter-storage

Description: Data import converter storage

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

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

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

mod-data-loader

Description: RMB based module used to load test data

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

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

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

mod-datasets

Description: Glint server module wrapper for FOLIO

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

mod-email

Description: Provides functionality for sending notifications

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

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

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

mod-erm-usage

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

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

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

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

mod-erm-usage-counter

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

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

mod-erm-usage-harvester

Description: Harvest ERM usage statistics

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

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

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

mod-event-config

Description: Provides functionality for the notification events

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

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

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

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

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.)

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

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

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

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

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

G-L

mod-gobi

Description: [Not provided]

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

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

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

mod-inventory

Description: [Not provided]

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]

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

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

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

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

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

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)

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

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

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

mod-licenses

Description: FOLIO service module - licenses

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

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

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

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

mod-login

Description: Module to handle username/password login

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

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

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

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

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

M-R

mod-marccat

Description: FOLIO metadata management / marccat module

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

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

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

mod-ncip

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

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

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

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

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

mod-notify

Description: Notifications to the users

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

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

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

mod-oai-pmh

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

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

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

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

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

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

mod-orders-storage

Description: Storage (CRUD) module for Orders

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

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

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

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

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

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

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

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

mod-patron

Description: [Not provided]

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

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

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

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

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

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

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

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

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

mod-receiving

Description: [Not provided]

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

mod-rtac

Description: [Not provided]

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

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

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

S-X

mod-sender

Description: Sending messages through delivery channels

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

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

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

mod-source-record-manager

Description: [Not provided]

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

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

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

mod-source-record-storage

Description: Persistent source record storage

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

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

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

mod-spring-sample

Description: Okapi Spring module example

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

mod-tags

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

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

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

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

mod-template-engine

Description: Stores templates and generates files by using them

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

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

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

mod-user-import

Description: [Not provided]

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

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

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

mod-users

Description: Domain Model to Manage Users

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

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

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]

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

Backend edge repos

9 repositories.

edge-common

Description: a shared library/framework for edge APIs

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

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

edge-lti-courses

Description: [Not provided]

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

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

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

edge-ncip

Description: Edge API for mod-ncip

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

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]

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]

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

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

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

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

edge-resolver

Description: UUID resolver

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

edge-rtac

Description: Edge API for RTAC (RealTime Availability Check)

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

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

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

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

edge-sip2

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

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

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

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

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

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

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

Shared RAML repos

3 repositories.

acq-models

Description: Central repository for the acquisition models

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

data-import-raml-storage

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

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

raml

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

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

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

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

Other repos

36 repositories.

A-I

data-import-processing-core

Description: The library to handle events from data-import

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

data-import-utils

Description: Library with common utilities for data-import modules

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

docs

Description: FOLIO Documentation

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

eslint-config-stripes

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

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

folio-analytics

Description: FOLIO reports and analytics

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

folio-ansible

Description: Ansible playbook for FOLIO

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

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

folio-api-tests

Description: FOLIO postman collections for backend modules

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

folio-custom-fields

Description: Store and maintain custom fields

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

folio-di-support

Description: 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

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

folio-holdingsiq-client

Description: Client library to HoldingsIQ API

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

folio-install

Description: 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

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

folio-isbn-util

Description: ISBN number converter utilities

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

folio-liquibase-util

Description: Liquibase utilities

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

folio-org.github.io

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

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

folio-perf-test

Description: Jenkins pipelines to test FOLIO performance and integration

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

folio-sample-modules

Description: Examples of FOLIO modules

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

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

folio-test-env

Description: [Not provided]

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

folio-testing-platform

Description: [Not provided]

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

folio-tools

Description: Various tools and support glue for FOLIO CI

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

generate-marc-utils

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

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

inventory-sample-data

Description: [Not provided]

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

J-R

jenkins-pipeline-libs

Description: Shared library for Jenkins Pipeline

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

mod-rmb-template

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

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

Net-Z3950-FOLIO

Description: A Z39.50 server for FOLIO bibliographic data

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

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

okapi-cli

Description: Okapi command-line interface

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

okapi-debian

Description: Experimental Debian Packaging Repo for Okapi

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

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

perf-testing

Description: Repository that houses tools and performance testing scripts

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

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

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

ui-app-template

Description: Stripes UI app module template

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

yakbak-proxy

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

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

Further information

Explanation about how the index is assembled and maintained:

Details of each repository that is hosted at FOLIO GitHub are gathered automatically (including information such as type of repository; does it have a “docs” directory; if backend, then does it have a “ramls” directory). This collection is done occasionally as a FOLIO DevOps infrastructure job. It is not yet automated, but is initiated manually. The resulting JSON file is committed as the _data/repos.json data file.

The data file _data/repos-metadata.yml contains additional metadata about some specific repositories. This information includes extra documentation links, beyond that gathered in the above-mentioned repos.json file (note that such links are intended as starting points, not to list every piece of documentation here). Please send pull-requests to add documentation links for your repository. The YAML structure is explained in the head of that file. The tool “yq” is useful for verifying YAML files (e.g. do yq '.' repos-metadata.yml).

Behind the scenes of this page source-code/map.md the Jekyll Liquid program assembles and presents this page.