Skip to content

v1.x RoadmapΒ #193

@UlisesGascon

Description

@UlisesGascon

🚧 Important

  • ⚠ This is a work in progress document β€” expect updates both now and in the near future.
    This issue continues the discussion from: MVP RoadmapΒ #30

🎯 Goals

  • Improve UX: VisionBoard is currently a CLI tool with a steep learning curve. We aim to offer a smoother, more intuitive experience.
  • Improve DX: The current codebase is growing in complexity and repetition, and testing is difficult to implement.

🧠 The Plan

  • Pivot from a CLI tool to a Web Application with two interfaces:

    • Web UI
    • Web API
  • The CLI will be moved to a separate repository and will consume the Web API:

    • Simplified interface using only arguments (no dynamic prompting).
    • Rewritten in TypeScript to test the viability of this stack.
    • Published as an npm package.
  • VisionBoard Web Server:

    • Will include a RESTful, versioned API (/v1).
    • Will serve as the Docker entrypoint.
    • Will dynamically generate reports using the existing template system.
    • Will optionally support static report generation (same as the current CLI).
    • No authentication layer, as it is meant to run locally by maintainers.
    • Built with Express v5 and standard middleware.
  • Scorecard Analysis Enhancements:

    • Introduce "roles", allowing the instance to act as either a scorecard runner or web server.
    • Implement a more robust strategy for incremental retries and fallbacks.
    • Add GitHub token rotation.
  • Alignment with the OpenJS Foundation: Security Compliance Guide v2.0.


πŸ› οΈ Next Steps

Sub-issues

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions