[Epic] CPAF - Create a Cross Platform Application Framework (CPAF) - Template

[OpCodeWolf]

Plan tasks (issues) that create a simple class based template that can be installed and executed across Linux, Windows, and Mac (OSx) platforms, with all of the requirements a general application should need.

(Please note that a bunch of this work has already been completed and will have no starter code branches. The initial code will be pushed with these tickets in mind)

Requirements

Engine

• Should be based on a new Cross Platform Application Framework without licensing restrictions or vagueness. (See: #36 )

Standard Application Requirements

• Should have a SDI (Single Document Interface) #7
• Should have modal dialog support #6
  • Input Dialog #17
  • Form Dialog #18
  • Button Dialog #19
  • Radio Dialog #20
• Should have an About Dialog for displaying LICENSE and other information. #22
• Should have system tray icon support #5
• Should have a config class to load and save settings from a config.json file
  • Should auto save and auto load the position of the applications main window as config settings #11
  • Should auto save and auto load the width and height of the applications main window as config settings #10
• Should have a resource class to load packaged resources #9
  • Should be able to load .png image files in a packaged assets directory
  • Should be able to load .ico icon files in a packaged assets directory
  • Should be able to load .ttf font files in a packaged assets directory
  • Should be able to load .css stylesheet files in a packaged assets directory
• Should have a default settings window (useful for ADA compliance)

Standard Accessibility Requirements - (WIP)

• Should adhere to the new rule on the Accessibility of Web Content and Mobile Apps Provided by State and Local Governments
  • See: https://www.ada.gov/resources/web-guidance/
  • See: https://www.ada.gov/resources/2024-03-08-web-rule/
  • See: https://www.w3.org/TR/WCAG20/
  • See: https://guides.18f.gov/accessibility/
• Should support switching themes
  • Should be able to switch the theme modes between different light, dark, high contrast, etc themes
• Should be compatible with popular screen readers, for those that might have an issue with reduction of sight.
  • ARIA Labels
  • Potential Audio Cues ( need more research on how this would work, or does the OS provide this? )
• Other? (WIP)

Packaging Requirements

• We are currently looking for a packager or will be writing our own.
• Should be packaged into a Debian redistributable (.deb) file #2
• Should be packaged into a Image redistributable (.AppImage) file #3
• Should be packaged into a Linux (x64) executable and redistributed as a .zip file #4
• Should be packaged into a Windows (x64) executable #14
  • This will likely need to be compiled on Windows
    • Potential Research Reference: https://github.com/vercel/pkg
• Should be packaged into a Mac OSx (.dmg) installer/executable #15
  • This will likely need to be compiled on OSx
    • Potential Research Reference: https://github.com/vercel/pkg

Testable Requirements

• Using MochaJS as a unit testing framework #12
  • Selenium can be used as an application testing protocol

Wants/Feature Requests

• We can figure out MDI later if needed. At this point roadmap items do not have this requirement. #13