Skip to content

Provide reliable local setup flows for monorepo templates #360

Description

@coderabbitai

Summary

Make the source-based template workflow in the /templates dashboard reliable for a monorepo. The current View Source action is useful for discovery, but the README/setup flow does not consistently let a user fetch and run the selected example.

Required changes

  • Add a template-specific local setup flow (for example, a Copy setup command action and/or matching expanded README instructions) for the React SDK Demo, Social Media demo, Python SDK Demo, and Kanban Board.
    • Standalone examples may use a sparse checkout command.
    • Instructions must include the actual cloned repository directory before changing into the example directory.
  • Correct examples/python-sdk-demo/README.md:
    • After cloning https://github.com/geturbackend/urBackend.git, change into the cloned repository directory before examples/python-sdk-demo.
  • Correct examples/social-demo/README.md:
    • Use the canonical https://github.com/geturbackend/urBackend.git repository URL.
    • Correct the cd path to include the cloned repository directory.
    • Update the documentation link to the canonical repository.
  • Resolve/document Kanban’s non-standalone dependency:
    • examples/sdk-kanban/server/package.json declares @urbackend/sdk as file:../../../sdks/urbackend-sdk.
    • Either make the setup command sparse-check out both examples/sdk-kanban and sdks/urbackend-sdk, or replace the local file dependency with an appropriate published SDK version.
  • Keep the dashboard metadata in apps/web-dashboard/src/pages/Templates.jsx, the expanded README content, and each example README consistent.

Affected areas

  • apps/web-dashboard/src/pages/Templates.jsx
  • examples/python-sdk-demo/README.md
  • examples/social-demo/README.md
  • examples/sdk-kanban/README.md
  • examples/sdk-kanban/server/package.json

Acceptance criteria

  • A user can follow the UI-provided or README-provided instructions to obtain and start each advertised source-based template without guessing paths.
  • All clone and documentation links use geturbackend/urBackend.
  • Python and Social setup commands work from a clean shell after cloning.
  • Kanban setup succeeds with its SDK dependency available, or no longer relies on a repository-local SDK path.
  • The template cards and their linked documentation describe the same supported workflow.

Backlinks

Metadata

Metadata

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