Skip to content

Latest commit

 

History

History
133 lines (126 loc) · 6.73 KB

File metadata and controls

133 lines (126 loc) · 6.73 KB

Directory Shape

Project

project/                         - Generated dygo project root
  .gitignore                     - Project ignore rules
  dygo.yml                       - Project config and marker
  cmd/                           - Project binaries live here
    dygo/                        - Project dygo runner
      main.go                    - Hook-aware CLI entrypoint
  apps/                          - App packages live here
    <app>/                       - App package bundle
      app.yml                    - App manifest and paths
      entities/                  - App Entity definitions
        <entity>/                - Normal Entity bundle
          <entity>.entity.yml    - Entity metadata definition
          hooks.go               - Entity hook scaffold
          fixtures.yml           - Entity fixture records
          views.yml              - Entity view metadata
        _collections/            - Collection row definitions
          <collection>.yml       - Single-file collection metadata
          <collection>/          - Folder-form collection bundle
            <collection>.entity.yml - Collection metadata definition
      access/                    - App access metadata
        _roles.yml               - App-contributed global roles
        <entity>.access.yml      - Entity access policy contribution
      jobs/                      - App background jobs
        <job>/                   - Job bundle
          job.yml                - Job metadata definition
          run.go                 - Job runner code
        _schedules.yml           - Recurring job schedules
      pages/                     - Custom app pages
        <page>/                  - Custom page bundle
          <page>.page.yml        - Page metadata definition
      reports/                   - Cross-Entity report definitions
        <report>.yml             - Single-file report metadata
        <report>/                - Folder-form report bundle
          report.yml             - Report metadata definition
  db/                            - Database generated artifacts
    schema.sql                   - PostgreSQL schema snapshot
  docs/                          - Project documentation files
  config/                        - Project config files
    secrets/                     - Encrypted environment secrets
    storage.yml                  - Future storage config
    queues.yml                   - Queue registry and concurrency config
    logging.yml                  - Future logging config
  .dygo/                         - Framework-managed Apps and local runtime state
    apps/
      core/                      - Tracked Core metadata required by fresh checkouts
      studio/                    - Cached Studio UI assets
    files/                       - Local uploaded files
    logs/                        - Local runtime logs
    tmp/                         - Local temporary files
    secrets/                     - Local private secret keys

Runtime

deploy/                          - Deployed project root
  bin/                           - Compiled runner and hooks
    dygo                         - Project dygo runner binary
  config/                        - Deployment config files
    dygo.yml                     - Runtime project config
    secrets/                     - Mounted secret files
  apps/                          - App metadata files
    crm/                         - Deployed business app
      app.yml                    - App manifest
      entities/                  - Entity metadata files
      access/                    - Role and Entity access metadata files
      jobs/                      - Job metadata files
      pages/                     - Custom page files
      reports/                   - Report metadata files
  db/                            - Runtime DB artifacts
    schema.sql                   - Deployed schema snapshot
  studio/                        - Studio static assets
    dist/                        - Static UI bundle
  storage/                       - Persistent runtime storage
    files/                       - Uploaded/generated files
      public/                    - Public runtime files
      private/                   - Private runtime files
    logs/                        - Runtime log files
    tmp/                         - Runtime temporary files

Framework

The framework repository uses this working tree:

dygo/                           - Framework repository root
  cmd/                          - Framework binaries live here
    dygo/                       - Stock dygo CLI
  internal/                     - Private framework packages
    app/                        - App discovery and registry
    auth/                       - Session authentication
    cli/                        - Cobra command implementation
    config/                     - Config loading defaults
    corevalues/                 - Built-in metadata constants
    db/                         - PostgreSQL runtime layer
    entity/                     - Entity metadata catalog
    fixtures/                   - Fixture loading runtime
    health/                     - Health check handlers
    hookevents/                 - Hook event definitions
    hookgen/                    - Hook scaffold generator
    hooks/                      - Hook runtime registry
    naming/                     - Record naming strategies
    patches/                    - Explicit patch runtime
    permissions/                - Permission evaluation logic
    project/                    - Project root discovery
    projectgen/                 - Project scaffold generator
    recordquery/                - Record query helpers
    reserved/                   - Reserved name registry
    secrets/                    - Encrypted secrets runtime
    server/                     - HTTP server runtime
    studio/                     - Studio asset handling
    upgrade/                    - Project upgrade runtime
    yamlmeta/                   - YAML metadata helpers
  apps/                         - First-party dygo apps
    core/                       - Core platform app
    studio/                     - Studio web app
  pkg/                          - Public Go API surface
    dygo/                       - App hook, Job, and logging API
  config/                       - Framework runtime config files
    secrets/                    - Encrypted dev secrets
    github.yml                  - GitHub repository and project board metadata
  db/                           - Framework DB artifacts
    schema.sql                  - Framework schema snapshot
  docs/                         - Framework documentation
  schemas/                      - Editor JSON Schemas
  scripts/                      - Release and helper scripts