Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.quepass.com/llms.txt

Use this file to discover all available pages before exploring further.

​
1. Prerequisites

  • Node.js >= 18.x 
  • npm >= 9.x (or yarn/pnpm) 
  • TypeScript >= 5.3.3 (recommended) 
  • Vite >= 6.0.0 (recommended bundler) 

​
2. Setup

1

CREATE A NEW REACT PROJECT

npm create vite@latest my-verification-app -- --template react-ts 
cd my-verification-app
2

INSTALL THE SDK

  • Option A - From local tarball: 
npm install ./path-to/quepass-sdk-1.0.0.tgz
  • Option B - From npm registry (when published): 
npm install @quepass/sdk
3

INSTALL REQUIRED DEPENDENCIES

npm install react-router-dom
4

IMPORT SDK STYLES

In your main entry file (main.tsx or index.tsx), import the SDK stylesheet: 
import "@quepass/sdk/dist/index.css";
5

PROJECT STRUCTURE (Reference: quepass-offline-app)

my-verification-app/ 
+— src/ 
|   +— App.tsx                    // Root application component 
|   +— main.tsx                   // Entry point with CSS imports 
|   +— routes/ 
|   |   +— Welcome.tsx            // SDK initialization page 
|   |   +— DocumentCapture.tsx    // Document-only capture 
|   |   +— FaceCapture.tsx        // Face-only capture 
|   |   +— DocumentFaceCapture.tsx // Document + Face capture 
|   |   +— Error.tsx              // Error handling page 
|   +— components/                // Shared UI components 
|   +— context/                   // React context providers 
+— package.json 
+— vite.config.ts 
+— tsconfig.json 
+— index.html 
  • REFERENCE APP DEPENDENCIES (quepass-offline-app/package.json):
{ 
  "dependencies": { 
    "@quepass/sdk": "file:../sdk/quepass-sdk-1.0.0.tgz", 
    "react": "^18.3.1", 
    "react-dom": "^18.3.1", 
    "react-router-dom": "^6.26.1", 
    "tailwindcss": "^4.1.9", 
    "framer-motion": "^12.23.0" 
  } 
}
  • RUNNING THE REFERENCE APP
cd my-verification-app 
npm install 
npm run dev          # Start development server 
npm run build        # Create production build