Skip to content

[Docs] Add .env.example for deployment/local setup #9

@Jayrodri088

Description

@Jayrodri088

Complexity / points: Trivial (100 points) - maintainer label: points-100-trivial

PR must include:

  • Closes #9 in the PR description
  • Tests added or updated where behavior changes
  • Docs updated if public API, lifecycle, or deploy steps change
  • No unwrap() in production Soroban contract paths (project convention)
  • cargo test passes locally; match CI (cargo fmt, cargo clippy -D warnings) when touching Rust

Problem

The repo expects contributors to use environment variables for deployment/invocation (see deployment commands in Readme.md and the .gitignore exception for .env.example), but .env.example is missing. That slows onboarding and increases setup errors.

Proposed change

Add a .env.example file at repo root with placeholder variables required for Soroban deploy/invoke flows.

Acceptance criteria

  • .env.example exists at repo root
  • Includes placeholders for at least:
    • Soroban secret key input (or a variable name that scripts can consume)
    • Network selection (testnet/mainnet)
    • Contract IDs for each deployed contract (invoice escrow/token/payment distributor)
    • Any initialization parameters shown in Readme.md (e.g., platform_fee_bps, admin)
  • README (or docs) references .env.example in the deployment section
  • Values are safe placeholders (no real secrets)

Dependencies

None.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions