Skip to content

Latest commit

 

History

History
40 lines (36 loc) · 1.82 KB

File metadata and controls

40 lines (36 loc) · 1.82 KB

Project Structure

What every part of the template is for.

.
├── README.md                 Project entry point and quickstart
├── package.json              Scripts and @quantova SDK dependencies
├── .env.example              Endpoints and keys template (copy to .env)
├── .gitignore                Ignores node_modules, .env, build output
├── src/
│   ├── client.js             Reusable q_ JSON-RPC client
│   └── config.js             Network selection (local | testnet | mainnet)
├── contracts/
│   ├── ExampleQRC20.sol      Example QRC20 token for the QVM
│   └── README.md             How to compile and deploy contracts
├── scripts/
│   ├── interact.js           Read height, chain id, balance
│   ├── deploy.js             Prepare/broadcast a QVM deployment
│   └── README.md             Script usage
├── test/
│   └── example.test.js       Starter tests (node:test)
├── docs/
│   ├── getting-started.md    This guide's neighbor — setup
│   ├── project-structure.md  You are here
│   ├── deploying.md          Deployment walkthrough
│   └── interacting.md        Reading and sending
└── .github/workflows/
    └── ci.yml                CI: install, lint, test

How the pieces fit