Client SDK Setup

For the purposes of this guide, thezkpass-sdk repository is cloned into the home directory of the current user, retaining its default name. This places thezkpass-sdk repository at ~/zkpass-sdk. As a result, the root directory for the zkpass-client-ts SDK is set to ~/zkpass-sdk/typescript/node-js/client.

Should you choose to clone the zkpass-sdk repository into a different location, ensure that you adjust any referenced paths in the instructions to match your chosen directory structure.

Client SDK Structures

To find out how the client SDK is structured, at the root of the zkPass SDK run the following:

cd ~/zkpass-sdk/typescript/node-js/client
tree -L 2

The output should look like this:

├── LICENSE
├── next.config.js
├── node_modules
├── package.json
├── package-lock.json
├── postcss.config.js
├── public
│   ├── next.svg
│   └── vercel.svg
├── README.md
├── src
│   ├── app
│   ├── components
│   └── utils
├── tailwind.config.js
├── tailwind.config.ts
└── tsconfig.json

Here are the descriptions for each sub directory:

• node_modules This contains all packages that are installed when running npm i. These packages are needed to run the sdk and app.

• src This is the main cli demo source code.