Understand OSF applications

You develop OSF storefront applications in a Yarn workspace on your local workstation, on which you are running a local Node.js instance.

The packages in the workspace organize the JavaScript code plus the layouts and other assets used in the storefront presentation layer. The workspace includes native Yarn tools for managing the packages, as well as Oracle-supplied scripts and commands for configuring and building applications. Setting up the workspace is described in Set Up a Development Environment.

By default, the widgets for the storefront presentation are written as React components. Widgets are used in conjunction with other elements (plug-ins) to implement their functionality. These elements include:

  • fetchers – Obtain data to generate the initial display of a widget.
  • subscribers – Passively observe store events and trigger communication of these events to external services.
  • actions – When invoked by widgets, send data that typically results in modification of the application's state.
  • endpoints – Assemble the payloads for, and make calls to, Store REST API endpoints.

The following diagram illustrates the roles of the various types of OSF application elements:

OSF application elements

See Create Custom Widgets for more information about these elements.

Once you have created your application, you can deploy it to one of the three server environments (test, staging, and production) that have been provided for you, as described in Develop and Deploy Applications.