From 6a06d1a127cc61aec97c13b9ac63838bd0eda629 Mon Sep 17 00:00:00 2001 From: Ahmet Abdullah Gultekin Date: Tue, 2 Jun 2026 01:32:03 +0000 Subject: [PATCH] docs: correct stale completion % + reconcile remaining npm-import snippets to CDN MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Pre-demo truth-in-claims pass: - README "Project Status: ~80% Complete (February 2026)" -> "Core platform production-deployed (June 2026)" with an accurate per-component table (79 migrations not 15; Android app live; iOS = roadmap) + an explicit "Known limitations" block (iOS/BYOD/demographics/pairwise/advanced-fusion/npm are roadmap or flag-off, not live). - tenant-onboarding.md: the install section already says "npm not yet published, use the CDN", but the code snippets still did `import { FivucsasAuth } from '@fivucsas/auth-js'` — reconciled to "FivucsasAuth is the global from the CDN script tag" so the doc no longer contradicts itself. (INTEGRATION_GUIDE.md was already CDN-corrected on main — no change needed.) Co-Authored-By: Claude Opus 4.8 (1M context) --- 01-getting-started/tenant-onboarding.md | 5 +++-- README.md | 27 ++++++++++++++++--------- 2 files changed, 21 insertions(+), 11 deletions(-) diff --git a/01-getting-started/tenant-onboarding.md b/01-getting-started/tenant-onboarding.md index 6194c19..8051218 100644 --- a/01-getting-started/tenant-onboarding.md +++ b/01-getting-started/tenant-onboarding.md @@ -33,7 +33,8 @@ For React projects, `@fivucsas/auth-react` is planned with hooks and ready-made ### 2. Initiate the login ```ts -import { FivucsasAuth } from '@fivucsas/auth-js'; +// FivucsasAuth is the global from the CDN script tag (Step 1) — no import needed. +// (When the @fivucsas/auth-js npm package ships, you will be able to import it instead.) const auth = new FivucsasAuth({ clientId: 'fiv_live_abc123', // from app.fivucsas.com admin console @@ -57,7 +58,7 @@ When the user finishes the auth flow on `verify.fivucsas.com`, the browser is re ```ts // pages/auth/callback (vanilla JS — works on any framework) -import { FivucsasAuth } from '@fivucsas/auth-js'; +// FivucsasAuth is the global from the CDN script tag (Step 1). const auth = new FivucsasAuth({ /* same config as above */ }); const params = new URLSearchParams(window.location.search); diff --git a/README.md b/README.md index e9e3bc3..6928308 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ > Multi-tenant biometric authentication platform for face recognition, liveness detection, and identity management. -**Project Status:** ~80% Complete | **University:** Marmara University | **Department:** Computer Engineering +**Project Status:** Production-deployed (core platform live) | **University:** Marmara University | **Department:** Computer Engineering --- @@ -168,19 +168,28 @@ ## 📊 Project Completion Status -**Overall:** ~80% Complete (February 2026) +**Overall:** Core platform production-deployed (June 2026). The API, biometric +processor, web dashboard, hosted login + OAuth/OIDC, and the 10 auth methods are +live in production; a per-feature truth-table (works / partial / roadmap) is +maintained in the repo audit docs. Some advanced layers are intentionally +roadmap/flag-off (see "Known limitations" below). ``` -Biometric Processor API: ████████████████████ 100% ✅ Production Ready -Demo Web GUI: ████████████████████ 100% ✅ 14+ interactive pages +Biometric Processor API: ████████████████████ 100% ✅ Deployed (face/voice/liveness) Web Admin Dashboard: ████████████████████ 100% ✅ React 18, Material-UI, deployed -Database Schema: ████████████████████ 100% ✅ PostgreSQL + pgvector, 15 migrations -Auth Flow Architecture: ████████████████████ 100% ✅ 10 design documents -NFC Reader (Universal): █████████████████░░░ 85% ✅ 10+ card types -Identity Core API: ██████████████████░░ 90% ⚠️ Multi-modal auth in progress -Mobile/Desktop UI: ████████████░░░░░░░░ 60% ⚠️ UI complete, integration pending +Identity Core API: ████████████████████ 100% ✅ Deployed — 10 auth methods, OAuth/OIDC, MFA +Database Schema: ████████████████████ 100% ✅ PostgreSQL 17 + pgvector, 79 Flyway migrations +Hosted login + SDK: ████████████████████ 100% ✅ verify.fivucsas.com + CDN SDK +NFC Reader (mobile): █████████████████░░░ 85% ✅ Serial/UID + ICAO 9303 BAC; chip passive-auth WIP +Mobile (Android): ██████████████████░░ 90% ✅ Android app (all 10 methods); iOS host app = roadmap ``` +**Known limitations (roadmap / not yet live):** iOS host app, BYOD (own-DB), +biometric demographics endpoint, OIDC pairwise subjects, the advanced multi-layer +anti-spoof fusion pipeline, and the `@fivucsas/*` npm packages are **planned / +flag-off** and should not be presented as live. NFC chip passive-authentication +needs a CSCA trust store. See the per-feature audit docs for the exact status. + **Details:** [Project Status](07-status/README.md) ---