Skip to content
This repository was archived by the owner on Aug 6, 2026. It is now read-only.

DEV_DATA.md

Latest commit

 

History

History
89 lines (58 loc) · 2.63 KB

DEV_DATA.md

File metadata and controls

89 lines (58 loc) · 2.63 KB
Raw

Development Data Management

When working with the Temba Components development server, demo flows and API data files are stored outside the project directory to allow for easier iteration without affecting the committed defaults.

How It Works

  • External Directory: Development data is stored in /tmp/temba-dev-data/
  • Automatic Setup: When you start the dev server, it automatically copies default files to the external directory if they don't exist
  • Fallback Logic: The server will use external files when available, but fall back to project defaults if not found
  • Persistence: Changes persist during development sessions but won't survive container rebuilds

Directory Structure

/tmp/temba-dev-data/
├── flows/          # Modified flow files
│   ├── food-order.json
│   └── sample-flow.json
└── api/            # Modified API response files
    ├── groups.json
    ├── labels.json
    ├── fields.json
    └── ... (15 total API files)

Available Commands

bun run dev-data:status

Shows the current state of development data:

bun run dev-data:status

bun run dev-data:copy / bun run dev-data:sync

Copies changes from development directory back to the project:

bun run dev-data:copy

This is useful when you want to commit your development changes.

bun run dev-data:reset / bun run dev-data:wipe

Wipes development data and restores from project defaults:

bun run dev-data:reset

This is useful when you want to start fresh or undo experimental changes.

Typical Workflow

  1. Start Development: bun run start

    • Server automatically sets up external data directory with defaults

  2. Make Changes: Edit flows or modify API responses through the application

    • Changes are saved to /tmp/temba-dev-data/

  3. Check Status: bun run dev-data:status

    • See what files are in development vs project directories

  4. Commit Changes (if desired): bun run dev-data:copy

    • Copies your changes back to the project for committing

  5. Reset When Needed: bun run dev-data:reset

    • Start fresh with default data

File Locations

  • Project Flows: demo/data/flows/
  • Project API: static/api/
  • Development Flows: /tmp/temba-dev-data/flows/
  • Development API: /tmp/temba-dev-data/api/

Notes

  • Development data doesn't survive container rebuilds
  • Always use bun run dev-data:copy before committing if you want to keep changes
  • The server prioritizes development files over project defaults when both exist
  • You can manually edit files in /tmp/temba-dev-data/ if needed