Skip to content

START_HERE.md

Latest commit

 

History

History
36 lines (20 loc) · 909 Bytes

START_HERE.md

File metadata and controls

36 lines (20 loc) · 909 Bytes
Raw

START HERE

If you downloaded a ZIP (or you’re preparing a small submission ZIP), start with AFTER_UNZIP.md.

➡️ Read: AFTER_UNZIP.md

Fastest demo (no install)

Open:

docs/index.html

This is the single-file dashboard (Dashboard / Issue Credential / Holder Wallet) and works offline.

What this repo contains

  • docs/index.html: GitHub Pages / offline demo dashboard.
  • src/: Node backend (optional).
  • circuits/: Circom circuits and (optionally) generated artifacts.
  • qs-ppi-dashboard/: React/Next dashboard (optional).

When you need npm install

If you want the backend or React app, you must run npm install after unzip because the lightweight package should not include node_modules/.

If your folder is too big

Use the cleanup steps in PACKAGING.md and the commands in COMMANDS.md.