Metricis Documentation¶

Metricis is an AI-native, standards-first Electronic Data Capture (EDC) and cognitive assessment platform for regulated clinical research. It combines a FastAPI backend, a researcher portal, a participant/caregiver portal, a jsPsych assessment client, and native mobile packaging through Capacitor.

Current Status¶

Area	Status
Operational gate	M7 sponsor-study cutover sign-off remains pending after local engineering preflight passed
Mobile platform	Capacitor 8.3.x, Android SDK 36, Java 21, Gradle 8.14.3, iOS simulator validation current
Release automation	GitHub Actions + Fastlane workflow added for web artifacts, Google Play, TestFlight, and App Store Connect
Documentation site	MkDocs source lives in `docs/`; GitHub Pages output is generated to `gh-pages`

Quick Links¶

Need	Start Here
Understand the system	Architecture Overview
Set up local development	Installation
Run tests	Testing Guide
Deploy production services	Deployment Guide
Build and publish mobile apps	Mobile Deployment
Run the release workflow	Release Automation
Publish documentation	Documentation Site
Execute sponsor cutover	Sponsor-Study Cutover
Review portal pages	UI Reference

Platform Overview¶

Metricis provides:

Cognitive assessments: jsPsych 8.x tasks for screening and deep phenotyping.
Researcher portal: Study setup, participant management, schedules, reports, exports, audit workflows, and AI-assisted configuration.
Patient portal: Mobile-first participant/caregiver experience with magic-link authentication, task queue, eConsent, schedules, and diaries.
Data quality: Validation, query management, source data verification, immutable audit logging, and regulatory exports.
REDCap integration: REDCap-managed study mode with DET webhooks, no-fallback sync policy, event mapping, and participant-facing survey launches.
Release automation: Semi-automated versioned release path through GitHub Actions environments and Fastlane lanes.

Portal Preview¶

Researcher Portal¶

Portal Dashboard

The researcher portal provides study management, participant tracking, battery configuration, schedule management, data review, exports, and audit operations. Explore Portal Pages

Patient Portal¶

Patient Portal Home

The patient portal gives participants and caregivers a mobile-first task queue, assessment launcher, consent flow, study schedule, and progress view. Explore Patient Portal Pages

Technology Stack¶

Layer	Current Stack
Assessment client	jsPsych 8.x, TypeScript, Vite, Dexie, Capacitor 8.3.x
Researcher portal	React 18, React Query, Tailwind CSS, Vite
Patient portal	React 18, React Router, React Query, i18next, Tailwind CSS
Backend	FastAPI, Python 3.11+, SQLAlchemy 2.x, Alembic
Data services	PostgreSQL 15+, Redis, Celery
Native mobile	Capacitor 8.3.x, Android SDK 36, Java 21, Gradle 8.14.3, Xcode/iOS simulator validation
Release automation	GitHub Actions, GitHub Environments, Fastlane, Bundler, Cloudflare Wrangler for landing deployment
Documentation	MkDocs Material, GitHub Pages, `gh-pages` generated branch

Project Structure¶

metricis/
├── client/          # jsPsych assessment frontend and Capacitor native projects
├── portal/          # Researcher/admin portal
├── patient-portal/  # Patient/caregiver portal
├── server/          # FastAPI backend
├── landing/         # Public landing site
├── docs/            # MkDocs documentation source
├── fastlane/        # Android/iOS release lanes
└── scripts/         # Release/versioning and utility scripts

Release and Deployment Entry Points¶

Use Deployment Guide for production server, database, Redis, SSL, and web frontend deployment.
Use Release Automation for the manual GitHub Actions workflow that builds web artifacts and native store packages.
Use Mobile Deployment for Capacitor 8 local builds, debug-device commands, signing requirements, deep links, and app store readiness.
Use Documentation Site for MkDocs/GitHub Pages publishing.