Skip to content

PACKAGING.md

Latest commit

 

History

History
57 lines (40 loc) · 1.76 KB

PACKAGING.md

File metadata and controls

57 lines (40 loc) · 1.76 KB
Raw

PACKAGING (Keep under 25 MB)

This project can be packaged as a lightweight ZIP (target: < 25 MB) that still runs the demo after unzip.

What must NOT be in the ZIP

Delete these before zipping:

  • node_modules/
  • qs-ppi-dashboard/node_modules/ (and dashboard/node_modules/ if it exists)
  • .next/, dist/, build/, artifacts/
  • Circom/SnarkJS generated files:
    • circuits/*.ptau
    • circuits/*.zkey
    • circuits/*.r1cs
    • circuits/*.wasm
    • circuits/*.sym
    • circuits/*.wtns

These items are the main reason a folder becomes 500MB–4GB.

Windows PowerShell cleanup (recommended)

cd "E:\Documents\Rahul Pal\Coding\Hackathon\QS-PPI\QS-PPI"
Remove-Item -Recurse -Force node_modules -ErrorAction SilentlyContinue
Remove-Item -Recurse -Force qs-ppi-dashboard\node_modules -ErrorAction SilentlyContinue
Remove-Item -Recurse -Force dashboard\node_modules -ErrorAction SilentlyContinue
Remove-Item -Recurse -Force .next,dist,build,artifacts -ErrorAction SilentlyContinue
Remove-Item -Recurse -Force circuits\*.ptau,circuits\*.zkey,circuits\*.r1cs,circuits\*.wasm,circuits\*.sym,circuits\*.wtns -ErrorAction SilentlyContinue

Verify folder size

cd "E:\Documents\Rahul Pal\Coding\Hackathon\QS-PPI\QS-PPI"
Get-ChildItem -Recurse | Measure-Object -Property Length -Sum | Select-Object @{Name="Size(MB)";Expression={[math]::Round($_.Sum/1MB,2)}}

Create the ZIP

Option A (Explorer): Right-click folder → Send to → Compressed (zipped) folder.

Option B (PowerShell):

cd "E:\Documents\Rahul Pal\Coding\Hackathon\QS-PPI"
Compress-Archive -Path .\QS-PPI -DestinationPath .\QS-PPI_light.zip -Force

After unzip

The ZIP should run instantly by opening:

docs/index.html

See: AFTER_UNZIP.md