Developer Documentation

Developer Documentation:

• Developer Setup
  • Requirements and Preparation
  • Setup Steps
  • Running Locally Quick Start
• Developer Setup on Amazon Linux 2023 on AWS EC2
  • Prerequisites
  • Lab 1 Summary and Modifications
  • Lab 3 Summary and Modifications
  • Setup Steps Specifics
• Setting Up Plant-Tracer webapp on Ubuntu 24.04
• Developer Setup Mac
• Mac Configuration
  • Prep your mac
  • Download and install the required software
  • Each time you reboot
  • Validate the release
• Developing locally
  • Getting started
  • Creating a course and a user
• 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
  • Planned Verification
  • Current Status
• Installation
  • Requirements and Preparation
  • Installation
  • Push to Lambda
• Environment Variables
  • Required
  • Optional for Demo Mode
  • Optional for using AWS
  • Optional for sending mail
  • Optional for Local Development
• 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
  • Local Development and GitHub Actions
• Movie attribution and research metadata
  • Philosophy
  • Implementation
• Architecture design principles
  • Get-movie-data and new-frame on Lambda
  • References
• Client Lambda API
  • Lambda API base URL
  • Endpoints used by the client
  • Tracking
  • Where the variable is set
• Flask API Reference
  • Authentication
  • Response Envelope
  • Endpoints
• PlantTracer Movie Processing Phases
  • Phase 1 – Infra / Bootstrap / Events
  • Phase 2 – Flask / JavaScript Orchestration
  • Phase 3 – UI Refinements and Status Display
  • Rotation and zip behavior (Phase 2)
  • Rotation in Lambda (no ffmpeg)
  • Lambda-only code and testing
• Web app theory of design
  • S3 bucket and long-term archive
  • Authentication
  • Use Stories
  • API
• Notes on simplfying the implementation
• Notes on Resizing
• Optional / possibly-missing dict keys – codebase scan
  • Category 1: Movie dict – keys that may be absent
  • Category 2: User dict – keys that may be absent
  • Category 3: Course dict – keys from DynamoDB
  • Category 4: DynamoDB / boto3 response shapes
  • Category 5: Item/frame from query or batch
  • Category 6: Newly created / in-memory dicts
  • Summary – high‑value fixes
  • Pydantic types for User and Movie – scope evaluation
• Coding Standards
  • Core Rules
  • Package Boundaries
  • Testing
  • Commands And Workflows
  • Documentation
• 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
  • Requirements
  • Implementation Plan
  • Testing Plan
• Gallery Learning Plan
  • Getting Started
  • Add the adder application
  • Future work
• Design of the movie player
  • API calls on that the JavaScript movie player can use
  • Client Side
  • Class Hierarchy
  • User Stories
• Bibliography
• Upload and Track User Story
  • User Story
  • Note
  • Agenda
• Notes on Deploying to SAM
  • Docker
  • Virtual Environment
  • Size
  • Commands to try:
  • CloudWatch log format and simple view
  • Set Up
  • References
• Configuration on mv1