Deploy the application

In OSF, much of the work of serving the presentation layer is delegated to a Node.js server. Widget code, for example, is part of the Node.js application.

In a development environment, the Node.js application runs in your local workspace, and communicates with Oracle-hosted Commerce servers. The JavaScript application can then be uploaded to a Node.js instance on a Commerce server environment, where it runs alongside administration and storefront instances. Each environment can run separate preview and live versions of the application.

Typically, developers have access to three server environments: test, staging, and production (see below). To deploy application changes to a server environment, you will need an application key specifically for that environment. You should be assigned a unique application key for each environment you have access to. Other developers may require access to different environments. For security purposes, you should avoid sharing your application keys with other developers or checking them into your source-control system.

When an application is deployed, the workspace itself is uploaded to the administration server. You can use the CLI to prepare the workspace for deployment, upload it, and track its status. See Workspace commands and scripts for information about the command-line tools available for managing storefront applications.

Because the entire workspace is deployed, it is possible for other developers to create their own workspaces from the deployed application, although it is recommended that they create their workspaces from source control. See Create a workspace from a deployed application.

Server environments

This section describes the test, staging, and production server environments.

Test environment

The test environment is intended to be used when creating an application. Developers create the initial set of components and layouts in their local workspaces and deploy them to the test environment as needed.

Staging environment

The staging environment is intended to be used as a pre-production environment for running the developed application. The application running in this environment should be similar to the production version in terms of business data and integrations. Developers and business users can test and refine the application in a simulated production environment.

Production environment

The production environment is where the public-facing version of the application runs. Major changes should not be rolled out to the production environment without first being tested in the test or staging environment. Access to the production environment should be strictly controlled to allow only a limited group of developers to update the production version of the application.

Deployment status

OSF provides commands for accessing deployment logs and monitoring the deployment status of applications. See Monitor deployed applications for more information.