Work Stream WS-12: Scaffolding & Developer Experience
| Attribute |
Value |
| FR ID |
FR-WS-12 |
| Priority |
P2–P3 |
| Tier |
1 — Independent Parallel |
| Depends On |
None |
| File Zone |
New files at src/dataviewer/ level, root package.json |
| Effort |
Medium |
| Tracking Issue |
#115 |
Description
Add developer experience scaffolding for the dataviewer application. Create .gitignore excluding sensitive and generated files. Create .env.example files documenting all required environment variables for both backend and frontend. Add cross-platform start scripts. Add devcontainer configuration. Add rollup-plugin-visualizer for bundle analysis. Add workspace reference in root package.json.
Issues addressed
- A-21 (HIGH): No
.gitignore in src/dataviewer/ — risk of committing .env files with secrets, __pycache__ directories, and node_modules
- A-22 (MEDIUM): No
.env.example files — new contributors have no documentation of required environment variables
- B-12 (MEDIUM): Platform-specific
start.sh script — no cross-platform alternative for Windows contributors
- B-19 (LOW): Root
package.json has no workspace reference to src/dataviewer/frontend/
- B-20 (LOW): No devcontainer configuration for consistent development environments
- G-07 (LOW): No bundle analysis tooling for monitoring frontend build size
- G-08 (LOW): Missing development convenience scripts (combined start, watch modes)
Findings Addressed
| Finding |
Severity |
Summary |
| A-21 |
HIGH |
No .gitignore — risk of committing secrets and generated files |
| A-22 |
MEDIUM |
No .env.example — undocumented environment variables |
| B-12 |
MEDIUM |
Platform-specific start script |
| B-19 |
LOW |
Root package.json missing workspace reference |
| B-20 |
LOW |
No devcontainer configuration |
| G-07 |
LOW |
No bundle analysis tooling |
| G-08 |
LOW |
Missing development convenience scripts |
Acceptance Criteria
Implementation Notes
.env.example should document: STORAGE_TYPE, AZURE_STORAGE_CONNECTION_STRING, CORS_ORIGINS, MODEL_PATH, API_BASE_URL, etc.
- Cross-platform option: npm scripts in root or dataviewer-level
package.json using concurrently for parallel backend + frontend
- Devcontainer: use
mcr.microsoft.com/devcontainers/python with Node.js feature, or a composite devcontainer
rollup-plugin-visualizer generates an HTML treemap of the production bundle — add as npm run analyze script
Related Issues
Migrated from Azure-Samples/azure-nvidia-robotics-reference-architecture#393
Work Stream WS-12: Scaffolding & Developer Experience
src/dataviewer/level, rootpackage.jsonDescription
Add developer experience scaffolding for the dataviewer application. Create
.gitignoreexcluding sensitive and generated files. Create.env.examplefiles documenting all required environment variables for both backend and frontend. Add cross-platform start scripts. Add devcontainer configuration. Addrollup-plugin-visualizerfor bundle analysis. Add workspace reference in rootpackage.json.Issues addressed
.gitignoreinsrc/dataviewer/— risk of committing.envfiles with secrets,__pycache__directories, andnode_modules.env.examplefiles — new contributors have no documentation of required environment variablesstart.shscript — no cross-platform alternative for Windows contributorspackage.jsonhas no workspace reference tosrc/dataviewer/frontend/Findings Addressed
.gitignore— risk of committing secrets and generated files.env.example— undocumented environment variablespackage.jsonmissing workspace referenceAcceptance Criteria
.gitignoreatsrc/dataviewer/level excludes.env*,__pycache__,node_modules,dist/,.venv.env.examplefiles for both backend and frontend list all environment variables with descriptions and safe defaultsrollup-plugin-visualizeravailable as dev dependency for build analysispackage.jsonincludes workspace reference tosrc/dataviewer/frontend/Implementation Notes
.env.exampleshould document:STORAGE_TYPE,AZURE_STORAGE_CONNECTION_STRING,CORS_ORIGINS,MODEL_PATH,API_BASE_URL, etc.package.jsonusingconcurrentlyfor parallel backend + frontendmcr.microsoft.com/devcontainers/pythonwith Node.js feature, or a composite devcontainerrollup-plugin-visualizergenerates an HTML treemap of the production bundle — add asnpm run analyzescriptRelated Issues
Migrated from Azure-Samples/azure-nvidia-robotics-reference-architecture#393