Enable Vesper content

info

The data retrieved from FORGE is used only to build the list cards and the hero/header sections of the detail pages.

Prepare your local development environment

This project requires environment variables managed in Vesper. To run the app locally and in CI, you must have the required variables available in your local environment.

Follow these steps to use the environment variables locally:

1. In the root folder of the Next.js app, create or update a file named .env.local.
   • Location: <nextjs-app-root>/.env.local
2. Request the .env.local contents from your Lead Engineer or a teammate via a LastPass Secure Note.
   • Do not share secrets via chat or email.
   • Do not commit .env.local to the repository.

The content of this file should look like:

FLAG_VESPER_ACCOUNT_ENABLED='true'
VESPER_API_KEY='key'
VESPER_REALM='realm'
VESPER_BASE_URL='https://url'
VESPER_APP='app'
VESPER_ENVIRONMENT='prod'

info

Be aware that...

• The .env.local file contains sensitive information. Get the environment variables from their owner through a LastPass secure note.
• The .env.local file contains information related to a specific environment. Changing the referenced environment requires updating the .env.local file.

Vesper authentication feature flag

Controls whether Vesper account authentication is enabled.

• If FLAG_VESPER_ACCOUNT_ENABLED=true, users can sign in using Vesper, and all related features are enabled.

Example:

FLAG_VESPER_ACCOUNT_ENABLED=true

Where to Find the Vesper-Related Code

All Vesper-related implementation, including the authentication flow, helpers, and UI integration, is located under:

src/features/vesper

Translations required for vesper components

The translation CSV contains all translations required for the Vesper components in en-GB language and can be uploaded directly to your Vocabulary tool (ask the project team).

Required site structure and link rules

For Vesper Modules and Layouts to work correctly, it is unfortunately necessary to follow specific site structure and link rules. This is because, in some cases, the required data cannot be fully retrieved from FORGE: not all videos included in playlists, seasons, and series come from FORGE, and seasons are not associated with their related series.

NEXUS modules definitions

To speed up and simplify the creation of new environments, this file contains the complete list of all the modules required for the entire NEXUS workflow.

In addition to these modules, one layout is also required.