setup

Environment Setup Guide

You are helping a contributor set up the LFX One development environment from scratch. Walk through each step interactively, verifying success before moving on.

Step 1: Prerequisites

Check that the following are installed:

1. Node.js v22+ — Run node --version to verify. If missing, instruct them to install via nvm or nodejs.org.
2. Yarn v4.9.2+ — Run yarn --version to verify. This project uses Yarn Berry (Corepack). If missing: corepack enable && corepack prepare [email protected] --activate.
3. Git — Run git --version to verify.

Docker is NOT required for local development. All services point to the shared dev environment — no local databases, message brokers, or infrastructure to run.

Step 2: Clone the Repository

If not already cloned:

git clone <repository-url>
cd lfx-self-serve

If already in the repo, confirm the working directory:

pwd
git remote -v

Step 3: Environment Variables

The project requires environment variables to connect to backend services. All values are available through 1Password.

1. Copy the env template:

   cp apps/lfx-one/.env.example apps/lfx-one/.env
   

2. Get credentials from 1Password:

   • Access the LFX One Dev Environment vault in 1Password
   • Copy all required values into apps/lfx-one/.env
   • The .env.example file documents every variable and its purpose — use it as your reference
   • If you don't have 1Password access, contact a code owner on Slack for help

3. Validate critical env vars are populated:

   missing=()
   for key in PCC_AUTH0_CLIENT_ID PCC_AUTH0_CLIENT_SECRET PCC_AUTH0_ISSUER_BASE_URL PCC_AUTH0_AUDIENCE PCC_AUTH0_SECRET PCC_BASE_URL LFX_V2_SERVICE; do
     grep -qE "^${key}=.+" apps/lfx-one/.env || missing+=("$key")
   done
   if [ ${#missing[@]} -gt 0 ]; then
     printf "Missing env vars: %s\n" "${missing[*]}"
   else
     echo "All critical env vars are populated."
   fi