Requirements

Functional Requirements

  1. The system shall allow administrators to upload images through a batch upload modal, storing each at multiple resolutions, associating them with a species record, and rejecting duplicate filenames. 
  2. The system shall allow administrators to create and manage species records with fields for common name, scientific name, description, taxonomic classification, and custom attribute definitions. 
  3. The system shall provide external student teams with read-only REST API access to species, images, and metadata authenticated via issued API keys, with all endpoints accessible using scientific name as the identifier. 
  4. The system shall provide a tagging system that categorizes images by named tag categories, with filtering support requiring all specified tags to be present on a result. 
  5. The system shall support marking a featured image per species and tag combination, which filtering endpoints will prioritize in their results. 
  6. The system shall allow administrators to manage user accounts, teams, and API keys, including creating, activating, deactivating, and extending key expiration dates. 
  7. The system shall provide role based frontend views that show or hide administrative controls based on the authenticated user's JWT role.
  8. The system shall allow users to toggle species name display between common name and scientific name across the entire interface. 

 

Non-Functional Requirements

  1. The admin interface shall be "pretty," with design decisions made with Nathan as the primary user in mind, and onboarding for new student teams shall require minimal setup.
  2. Image upload and retrieval operations shall complete in a reasonable time under normal load.
  3. The system shall support new species, images, tags, and teams each semester without architectural changes.
  4. The codebase shall be documented and structured so future teams can understand and extend it with minimal onboarding time.
  5. Frontend filtering shall use CSS-based DOM manipulation rather than rebuilding HTML elements, preventing lag on large datasets.
  6. The application shall support light and dark modes globally across all components without breaking readability or contrast.
  7. Metadata updates shall reflect immediately in the interface while database synchronization happens in the background.