Repository navigation
Provide reliable local setup flows for monorepo templates #360
Copy link
Copy link
Closed
Description
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 beforeexamples/python-sdk-demo.
- After cloning
- Correct
examples/social-demo/README.md:- Use the canonical
https://github.com/geturbackend/urBackend.gitrepository URL. - Correct the
cdpath to include the cloned repository directory. - Update the documentation link to the canonical repository.
- Use the canonical
- Resolve/document Kanban’s non-standalone dependency:
examples/sdk-kanban/server/package.jsondeclares@urbackend/sdkasfile:../../../sdks/urbackend-sdk.- Either make the setup command sparse-check out both
examples/sdk-kanbanandsdks/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.jsxexamples/python-sdk-demo/README.mdexamples/social-demo/README.mdexamples/sdk-kanban/README.mdexamples/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
- PR: feat(devex): add project templates, Python SDK demo, quickstart scrip… #359
- Originating review discussion: feat(devex): add project templates, Python SDK demo, quickstart scrip… #359 (comment)
- Requested by: @yash-pouranik
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels
Activity