Developer Documentation

Developer Documentation:

• Developer Setup
  • Requirements
  • Clone And Install
  • Local Services
  • Run Locally
  • Validation
  • Create A Course
  • Cleanup
• Developer Setup On Amazon Linux 2023 EC2
  • Base Packages
  • Checkout And Install
  • Local Development
• Setting Up Plant Tracer On Ubuntu 24.04
  • Local Run
  • Validation
  • Cleanup
• Developer Setup Mac
  • Install Tools
  • Clone And Install
  • Local Services
  • Run The App
  • Validate
  • Inspect Local Data
  • Cleanup
• Windows Developer Setup Notes
• Local Development and GitHub Actions
  • Why This Document Exists
  • Architecture Summary
  • Local Topology
  • Local Testing Goals
  • Design Decision: Use a Second Native Python Process
  • Design Decision: Do Not Require a Real Local SQS Service
  • Environment Variables
  • JavaScript Runtime Variables
  • Recommended Make Targets
  • Browser Request Flow
  • Local Retrace Flow
  • Why Not Make Flask Pretend To Be Lambda
  • Why Native Python First Instead of SAM Local
  • GitHub Actions
  • Verification Targets
  • Current Status
• Installation
  • Repository Checkout
  • Install Dependencies
  • Local Application
  • Non-Demo Course
  • Mailer Configuration
  • Validation
• Environment Variables
  • Required
  • AWS And Local Service Selection
  • Application URLs
  • Demo Mode
  • Mail
  • Lambda Queue
  • Development And Diagnostics
  • Local Makefile Defaults
• Demo Mode
  • How Demo Mode Is Enabled
  • What DEMO_COURSE_ID Means
  • Behavior in Demo Mode
  • Local Development
  • Rendering and UI
  • Troubleshooting
• Configuring AWS
  • Planttracer.com setup
• Deploying To EC2
• DynamoDB and Plant Tracer
  • Table Summary
  • Table Details
  • Data Consistency Notes
  • Schema and Naming Changes
• S3 and Plant Tracer
  • Object Layout
  • Local Development and GitHub Actions
• Movie attribution and research metadata
  • Philosophy
  • Implementation
  • Capture interval (frames per minute)
• Architecture Design Principles
  • Frames And Video: lambda-resize
  • HTML: flask_app
  • Metadata: flask_api
  • Storage Boundary
  • References
• Lambda Web Migration Discussion
  • Status
  • Recommended Direction
  • Decision 1: Current Lambda Or New Lambda
  • Decision 2: Static Pages And Assets From Lambda Or S3
  • Decision 3: Continue Supporting VM Operation
  • Other Decisions To Make
  • Work To Do
  • Questions For Approval
• Client Lambda API
  • Lambda API Base URL
  • Endpoints
  • Trace Movie Request
  • Local Development
• Flask API Reference
  • Authentication
  • Response Envelope
  • Endpoints
• Trackpoint Coordinate System
  • Purpose
  • Coordinate Spaces
  • Frame Height Source
  • DynamoDB Contract
  • Legacy Migration
  • Browser Responsibilities
  • Graph Responsibilities
  • Flask API Responsibilities
  • Lambda Tracking Responsibilities
  • Tests
  • Documentation Follow-up
• Video Trim Design
  • Scope
  • Stored Metadata
  • Validation
  • Analyze Page Controls
  • Trackpoint Rules
  • Movie Player Behavior
  • Tracer Lambda Behavior
  • Outputs
  • Unresolved Questions
  • Implementation Checklist
• Analyze: Aggregate Result Statistics
  • Result modes
  • Gravitropism
  • Circumnutation
  • Rate and the capture interval (fpm)
  • Reserved marker names
• Plant Tracer Movie Processing
  • Upload
  • First Frame
  • Playback
  • Retracing
  • Local Process Model
  • Video Processing Library
• Web App Theory Of Design
  • Storage
  • Authentication
  • Service Boundaries
  • Upload Flow
  • Analyze Flow
  • Movie List Flow
  • Faculty/Admin Flow
• Notes on simplfying the implementation
• Notes on Resizing
• Optional / Possibly Missing Dict Keys
  • Current Risk Areas
  • Current Model Boundary
  • Recommended Direction
• Coding Standards
  • Core Rules
  • Python
  • JavaScript
  • Storage And Services
  • Testing
  • Documentation
• Technical Debt Review
  • Easy / Fast
  • Medium
  • Long Term
  • Reviewed Hotspots
• Release Process
  • Overview
  • Step 1 — Merge Feature PRs
  • Step 2 — Bump the Version Number
  • Step 3 — Prepare the GitHub Milestone
  • Step 4 — Tag the Release
  • Step 5 — Generate Release Notes and Create the Release
  • Known Gaps
• Gallery Of Plant Videos
  • Purpose
  • Current Storage Model
  • Implementation Direction
• Gallery Learning Plan
  • Current Framework
  • Exercise
  • Gallery Direction
• Movie Player Design
  • Runtime Inputs
  • Frame And Playback APIs
  • Client Classes
  • State Variables
  • Retrace Flow
  • Invariants
• Bibliography
• Upload And Track User Story
  • Upload
  • Analyze
  • Track Movie
  • Retrack
  • Download
  • Open Questions
• Notes on Deploying to SAM
  • Docker
  • Virtual Environment
  • Size
  • Commands to try:
  • CloudWatch log format and simple view
  • Set Up
  • References
• Configuration on mv1