Home - striae-org/striae GitHub Wiki

This wiki provides guidance for developers working on Striae, a cloud-native forensic annotation platform for firearms identification workflows.

Important Note: Striae is actively developed. Documentation may lag implementation in some areas. Validate behavior against the repository when needed. (Docs last updated April 25, 2026, Striae v7.1.0)

Quick Start

New to Striae? Start here:

1. Project Overview - Product scope, role, and capability map
2. Installation Guide - Prerequisites, deployment steps, and troubleshooting
3. Environment Variables Setup - Required secrets, bindings, and runtime configuration
4. Architecture Guide - Service boundaries and system patterns
5. Security Guide - Security boundaries, auth flow, and deployment-sensitive controls
6. Guide Summaries - TL;DR summaries with direct links to core guides

Core Documentation

Architecture and Platform

• Architecture Guide - System architecture and design patterns
• Component Guide - Frontend component architecture
• Utilities Guide - All app/utils/ modules: auth, permissions, data operations, signing, and helpers
• API Reference - Worker endpoint contracts and schemas
• Guide Summaries - Quick TL;DR hub for core docs

Security and Workflow

• Security Guide - Security controls, auth boundaries, and hardening checks
• Authenticated Confirmation System - OE/RE confirmation lifecycle and validations
• Manifest & Confirmation Signing - Signature payload rules, envelopes, and verification behavior
• Export Encryption - Export package encryption, ENCRYPTION_MANIFEST.json, and import-time decryption
• Data-at-Rest Encryption - Worker-side encryption at rest for case data, user profiles, audit logs, and file/image storage
• Audit Trail System - Audit event model and reporting workflows

Reporting and Operations

• PDF Report System - Modular report rendering architecture
• Error Handling Guide - UI and service-layer error handling patterns

By Task

• Deploy and configure environments: Installation Guide, Environment Variables Setup, repository README, app/config-example/, and worker wrangler.jsonc files
• Understand system boundaries: Project Overview, Architecture Guide
• Implement or review frontend behavior: Component Guide, Error Handling Guide
• Implement or review worker behavior: API Reference, Manifest & Confirmation Signing, Export Encryption
• Validate security and forensic trust workflows: Security Guide, Authenticated Confirmation System, Manifest & Confirmation Signing, Export Encryption, Audit Trail System

Contributing Documentation

1. Identify outdated or missing information.
2. Update docs in the same change that updates code behavior.
3. Prefer short, implementation-aligned guidance over duplicated prose.
4. Link to source-of-truth guides instead of restating detailed behavior.

External Resources

• GitHub Repository
• Issue Tracker
• GitHub Discussions
• Cloudflare Workers Documentation
• Firebase Documentation

Getting Help

• Documentation issues: open a docs-focused issue in the repository.
• Development issues: check existing docs and issues, then open a new issue with reproduction details.
• Security issues: follow responsible disclosure and avoid public disclosure of sensitive details.

---