1.0.3 • Published 1 year ago

create-tezos-app v1.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

Hi.

Tezos

This repo will guide you to create / compile and deploy your smartpy contracts on tezos network.

Here's how you should start.

Prerequisites (Don't skip this)

Install SmartPy CLI Tool: https://smartpy.io/docs/cli/ Now, you are good to go.

How to install

Here's the command.

npx create-tezos-app name-of-your-dapp

Folder structure

|---bin (You should totally ignore this, its npmjs shit)
|---config
|------config.ts (Declaring config constants)
|---contracts
|------build (This is where your compiled Michaelson contracts are saved as json files.)
|------src (This is where you keep your smartpy contracts.)
|---scripts (This is where deploy script is saved, more if created in future.)

NOTE: A sample contract has been kept in the repo and compiled for reference.

What's in the ENV?

Create a .env file with the keys mentioned in the .env.example file.

  1. ORIGINATOR_PRIVATE_KEY -> Add the private key through which you'd want to deploy your contracts.

Commands you should know

Compiling a contract

npm run compile [contractName]

Example: npm run compile counter

Note: Make sure the contract name is in lowercase and is inside the contract/src/ folder.

Originating (Deploying) a contract

npm run deploy [contractName] [@network]

Example: npm run deploy counter @mainnet
         npm run deploy counter @ghostnet
         npm run deploy counter @kathmandunet
         npm run deploy counter @jakartanet

Note: Make sure the compiled contracts are inside the contract/build/ folder.

More commands coming soon.