How robgura/rally-page works
Main Components
a. Client-Side Application Layer
• Main application bundle (compiled from src/index.js)
• HTML container (src/index.html)
• CSS styling component (src/styles.css)
b. Build System Layer
• Webpack configuration (split into common, dev, and prod)
• Babel transpilation (.babelrc)
• ESLint for code quality (eslint.config.mjs)
c. Rally Integration Layer
• Custom HTML app container in Rally
• Rally API integration points
Component Relationships
• [Development Flow]
• Source Files → Build System → Deployed Bundle
• [Runtime Flow]
• Rally Dashboard → Custom HTML Container → Application Bundle → Rally API
Important Details to Capture
a. Development Environment:
• Local development server (Python SimpleHTTPServer)
• Webpack watch mode for development
• Build process for production deployment
b. Deployment Flow:
• How the built bundle (deploy/index.html) gets deployed to Rally
Create three main sections:
• Development Zone |
• (Source + Build Tools) |
• Deployment Pipeline |
• (Build + Bundle) |
• Runtime Environment |
• (Rally Integration) |
Additional Notes
• Annotations for important configuration files
• Npm scripts workflow
• Where environment-specific configurations apply
Remember to maintain a balance between detail and clarity. Since this is a relatively straightforward frontend application, focus on clearly showing:
The runtime behavior
This will give other developers a clear understanding of how the application is structured, built, and deployed, while also showing its integration points with the Rally platform.