FOLIO - Developer Onboarding Index

This page serves as an index of developer-facing documentation to aid in onboarding and for future reference.

Background

• A Window into FOLIO

Community

• Councils

  • Technical

  • Product

  • Community

• SIGs

• Regional SIGs

• Teams

• Slack

Roadmap

• Technology

• Product

Releases

• Flower Releases

• Roles and Responsibilities

• Actual Steps 

• Public Releases

• Under Development

  • Lotus (R1 2022)

  • Morning Glory (R2 2022)

• Current Development Status

  • Sprint status

  • Release Status

• Versioning

System Requirements

• OpenJDK 11.x

• Git, Insomnia/Postman, MarcEdit 3.5

• IDE - IntelliJ, Eclipse, VS Code

• Vagrant

• Operating Systems - Mac OS/Linux

• Development Tools

Design & Architecture

• https://github.com/folio-org/okapi/blob/master/doc/guide.md

• Logical System Arch

• Deployment Arch - Logical and Physical

• Security Model

  • Guides to FOLIO Permissions

  • https://github.com/folio-org/okapi/blob/master/doc/guide.md#permissions-and-the-_tenantpermissions-interface

• Dependencies

Installation

• https://iris.docs.folio.org/docs/getting-started/installation/

• Folio Installation (For active development)

• Folio Installation (Access ONLY)

Configuration

• https://iris.docs.folio.org/docs/settings/

• System Config

  • DB 

  • Logging

  • SSO

  • Email

• App Config

Development

• Newcomer's first steps

• Getting started

• Code Repository

• https://dev.folio.org/guidelines/development-design-review

• https://dev.folio.org/guidelines/

• Do's and Don'ts

• Presentation

  • Tech Stack

  • Component Library 

  • Design system

  • New App Development

• Services/Backend

  • Tech Stack

  • New module Development

  • New module checklist

• Database/Persistence

  • ER diagrams

  • Export/Import

  • Data Migration

  • https://folio-org.atlassian.net/wiki/display/FOLIJET/How+to+test+data+migration+scripts+locally

  • Schema upgrades

  • Loading Sample Data

Build and Deployment

• CI/CD process

• Backend module lifecycle

• Jenkins

• Test Coverage

• Artifacts

API Access & Integrations

• API Documentation

Environments

• FOLIO Reference environments (e.g. folio-snapshot)

• Bugfest environment

Resources

• User Guides 

• https://app.vagrantup.com/folio

• https://dashboard.folio.ebsco.com/

• Terminology

• Acronyms (Currently archived)

• Postman Collection

• Developer KB - Known Issues and Solutions, How do I ....?

• https://wiki.code4lib.org/A_Guide_for_the_Perplexed

• https://repository.folio.org/#browse/browse