πŸ“—
UpGrade Platform - Documentation
6.0
6.0
  • UpGrade Overview
  • Creating an Experiment
    • Unit of Assignment
    • Simple Experiment
    • Factorial Experiment
    • Inclusion and Exclusion
    • Schedule and Post-Rule
    • Exporting Experiment Data and Design
  • Creating a Feature Flag
  • How UpGrade Works
  • Researcher Guide
  • Developer Guide
    • ⚑Quick Start: Running UpGrade Locally with Docker
    • ⚑Quick Start: Running locally w/o Docker
    • UpGrade + AdapComp (Mooclet) in Docker
    • πŸšΆβ€β™€οΈWalkthroughs
      • Your Application and UpGrade
      • Example 1: A Quiz Web App
      • Example 2: An Online Math Game
    • πŸ“šReference
      • API
      • Client Libraries
        • TypeScript / JS
          • Class: UpgradeClient
          • Class: Assignment
          • SDK Interfaces
            • Interface: IMetric
            • Interface: IExperimentUser
            • Interface: IExperimentUserAliases
            • Interface: ILog
            • Interface: IMarkExperimentPoint
            • Interface: IMetric
            • Interface: IRequestOptions
            • Interface: IResponse
            • Interface: IUser
            • Interface: IUserGroup
      • Environment Variables
        • Frontend Environment
        • Backend Environment
      • Context Metadata
      • Metrics
      • Setting up Google-Auth
      • API Authorization
      • Data Architecture
    • πŸ‘¨β€πŸ’»Contributing Code
      • Branching Workflow (Git-Flow)
      • Pull Request Expectations
    • πŸ˜…Troubleshooting
      • Relation β€˜experiment_condition’ already exists
      • User not found. Authorization error
      • Token is not present in the request header
      • nodemon exits without explanation
      • Unable to find New Relic module configuration
      • No email received for export data
      • Opening a new tab in UpGrade prompts for re-authorization
      • Error: Cannot find module 'upgrade_types' (or a type from 'upgrade_types' does not exist)
  • Glossary
Powered by GitBook
On this page
  1. Developer Guide
  2. Reference
  3. Environment Variables

Frontend Environment

Notes on frontend config options


export const environment = {
  // name it whatever you like
  appName: 'UpGrade',
  // envName isn't currently used
  envName: 'DEV',
  // your backend service api domain
  apiBaseUrl: 'http://localhost:3030/api',
  // use production: true to quiet dev console message
  production: false,
  // this also quiets debug messages, leave as is
  test: false,
  // configure baseHref if needed by server routing
  baseHrefPrefix: '', //
  // configure hash routing if needed by server routing
  useHashRouting: false,
  // this is important! see the google client id page, must match the id in backend env
  googleClientId: ''
  // can be used to restrict domains of users logging in on client  
  domainName: '',
  // when pollingEnabled is true, an experiment details page will receive periodic updates
  pollingEnabled: false,
  // how oftern those updates are (ms)
  pollingInterval: 10 * 1000,
  // how long to poll before quitting (ms)
  pollingLimit: 600,
  // show feature flag feature in UI
  featureFlagNavToggle: true,
  // show new segments UI
  segmentsRefreshToggle: true,
  // allow within-subjects feature
  withinSubjectExperimentSupportToggle: false,
  // allow error logs feature
  errorLogsToggle: false,
  // show metrics graphs in data page
  metricAnalyticsExperimentDisplayToggle: true,
  // allow mooclet API feature integration (this is a special setup to integrate with Mooclet API server)
  moocletToggle: true,
  // api routes, leave as-is unless you know what you're doing!
  api: {
    getAllExperiments: '/experiments/paginated',
    createNewExperiments: '/experiments',
    validateExperiment: '/experiments/validation',
    importExperiment: '/experiments/import',
    exportExperiment: '/experiments/export',
    exportAllExperiment: '/experiments/export/all',
    updateExperiments: '/experiments',
    experimentContext: '/experiments/context',
    getExperimentById: '/experiments/single',
    getAllAuditLogs: '/audit',
    getAllErrorLogs: '/error',
    experimentsStats: '/stats/enrollment',
    experimentDetailStat: '/stats/enrollment/detail',
    generateCsv: '/stats/csv',
    experimentGraphInfo: '/stats/enrollment/date',
    deleteExperiment: '/experiments',
    updateExperimentState: '/experiments/state',
    users: '/users',
    loginUser: '/login/user', // Used to create a new user after login if doesn't exist in DB
    getAllUsers: '/users/paginated',
    userDetails: '/users/details',
    previewUsers: '/previewUsers',
    stratification: '/stratification',
    getAllPreviewUsers: '/previewUsers/paginated',
    previewUsersAssignCondition: '/previewUsers/assign',
    allPartitions: '/experiments/partitions',
    allExperimentNames: '/experiments/names',
    featureFlag: '/flags',
    updateFlagStatus: '/flags/status',
    updateFilterMode: '/flags/filterMode',
    getPaginatedFlags: '/flags/paginated',
    validateFeatureFlag: '/flags/import/validation',
    validateFeatureFlagList: '/flags/lists/import/validation',
    importFeatureFlag: '/flags/import',
    importFeatureFlagList: '/flags/lists/import',
    exportFlagsDesign: '/flags/export',
    exportFFAllIncludeListsDesign: '/flags/export/includeLists',
    exportFFAllExcludeListsDesign: '/flags/export/excludeLists',
    emailFlagData: '/flags/email',
    addFlagInclusionList: '/flags/inclusionList',
    addFlagExclusionList: '/flags/exclusionList',
    setting: '/setting',
    metrics: '/metric',
    metricsSave: '/metric/save',
    queryResult: '/query/analyse',
    getVersion: '/version',
    contextMetaData: '/experiments/contextMetaData',
    segments: '/segments',
    validateSegments: '/segments/validation',
    importSegments: '/segments/import',
    exportSegments: '/segments/export/json',
    exportSegmentCSV: '/segments/export/csv',
    getGroupAssignmentStatus: '/experiments/getGroupAssignmentStatus',
  },
PreviousEnvironment VariablesNextBackend Environment

Last updated 2 months ago

πŸ“š