Skip to content

buildconfig-setup.md

Latest commit

 

History

History
82 lines (58 loc) · 2.54 KB

buildconfig-setup.md

File metadata and controls

82 lines (58 loc) · 2.54 KB
Raw

BuildConfig Setup Guide

This project uses BuildKonfig to securely manage build configuration variables like Supabase credentials.

Configuration

Option 1: Using local.properties (Recommended for local development)

  1. Open local.properties in the project root
  2. Uncomment and add your Supabase credentials:
supabase.url=https://your-project-id.supabase.co
supabase.key=your-anon-public-key
bugsnag.apiKey=your-bugsnag-api-key

Option 2: Using Environment Variables (Recommended for CI/CD)

Set the following environment variables:

export SUPABASE_URL=https://your-project-id.supabase.co
export SUPABASE_KEY=your-anon-public-key
export BUGSNAG_API_KEY=your-bugsnag-api-key

Priority

The configuration uses the following priority (first found wins):

  1. local.properties file
  2. Environment variables
  3. Default placeholder values (will not work with real Supabase)

Finding Your Supabase Credentials

  1. Go to your Supabase Dashboard
  2. Select your project
  3. Go to Settings → API
  4. Copy:
    • Project URL → Use as supabase.url or SUPABASE_URL
    • Project API key (anon public) → Use as supabase.key or SUPABASE_KEY

Usage in Code

The BuildConfig class is generated in the client:shared module and can be accessed from any module that depends on it:

import com.plusmobileapps.chefmate.buildconfig.BuildConfig

val supabaseUrl = BuildConfig.SUPABASE_URL
val supabaseKey = BuildConfig.SUPABASE_KEY
val bugsnagApiKey = BuildConfig.BUGSNAG_API_KEY

Adding New Configuration Values

To add new build configuration values, edit client/shared/build.gradle.kts:

buildkonfig {
    packageName = "com.plusmobileapps.chefmate.buildconfig"
    objectName = "BuildConfig"

    defaultConfigs {
        buildConfigField(STRING, "SUPABASE_URL", supabaseUrl)
        buildConfigField(STRING, "SUPABASE_KEY", supabaseKey)
        // Add your new field here
        buildConfigField(STRING, "NEW_FIELD", newValue)
    }
}

Security Notes

  • Never commit local.properties with real credentials - it's already in .gitignore
  • The anon/public key is safe to use in client-side code (it's meant to be public)
  • For sensitive operations, always use Row Level Security (RLS) in your Supabase database

Related

  • developer-settings.md — how to wire up the staging Supabase URL (supabase.testing.* / SUPABASE_TESTING_*) and pre-baked test users for the in-app developer menu.