SecureVault

Product-first feature tour

Review the user-facing capabilities first, then see why each feature is backed by scalable, production-facing architecture.

MariaDB-centered system design

The app uses MariaDB for far more than auth tables, including upload state, sharing controls, activity history, lifecycle management, and vector-backed semantic retrieval.

Shared-preview security model

The docs now explain SSR access gates, email allowlists, OTP sessions, protected preview rendering, no-store headers, and honest browser-copying limits.

Repository grounded

Every page is derived from current repository behavior, including API routes, Docker workflows, security controls, and test coverage.

GitHub Pages ready

The docs build as a static VitePress site and deploy through the official GitHub Pages Actions flow rather than a generated branch.

What lives here

Read the docs in this order if you are new to the project:

Feature Tour explains what SecureVault can do and why each feature is architecturally credible.

Demo Walkthrough gives reviewers a clean path through the live product experience.

Security In Plain English explains the security posture and honest limits for non-technical readers.

Technical Feature Architecture maps the same capabilities to the engineering design.

Local Development gets the app and services running.

Project Handbook remains the broad product and engineering reference.

Shared Preview Protection documents the detailed shared-preview threat model.

API Reference lists route-level contracts, access rules, limits, and response headers.

Docker and Compose covers container workflows and environment expectations.

Playwright Coverage describes the end-to-end test surface.

Benchmark Workflows explains semantic retrieval and pipeline benchmarks.

UI Showcase gives a fast visual tour without running the app.

Documentation principles

Keep public docs grouped by user intent instead of by the order they were written.

Put security notes near the flows they protect, then link to dedicated deep dives for details.

Prefer relative links between pages so the docs work both on GitHub and on the published site.

Store static site assets under docs/public/ so GitHub Pages builds do not depend on files outside the docs source tree.

Deploy with GitHub Actions artifacts, which is GitHub's recommended path when you need a static site build step.

Why MariaDB matters in SecureVault

MariaDB is the single durable system of record for auth, sessions, uploads, sharing, quotas, activity, and semantic indexing state.

Transactional flows matter in this repo: password-reset OTP consumption, share governance, and upload completion all depend on consistent database behavior.

The semantic retrieval path is still part of the MariaDB story because indexed chunks and vectors are stored in MariaDB and ranked there before the app formats results.

That combination makes the project a stronger MariaDB hackathon submission than a typical app that only uses the database for basic CRUD.

SecureVault DocsProduct depth, system design, and operating guidance in one place