https://github.com/okwme/dapp-scratch

CLI for generating javascript modules from Solidity Contracts for Decentralized Apps
https://github.com/okwme/dapp-scratch

Last synced: 3 months ago
JSON representation

CLI for generating javascript modules from Solidity Contracts for Decentralized Apps

• Host: GitHub
• URL: https://github.com/okwme/dapp-scratch
• Owner: okwme
• License: isc
• Created: 2017-11-08T16:31:42.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-07-13T08:37:45.000Z (almost 6 years ago)
• Last Synced: 2024-04-13T23:05:43.760Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 423 KB
• Stars: 41
• Watchers: 3
• Forks: 15
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• awesome-solidity - dapp-scratch - CLI for generating javascript modules from Contracts for Decentralized Apps. (Tools)
• awesome-solidity - dapp-scratch - CLI for generating javascript modules from Contracts for Decentralized Apps. (Tools)
• awesome-solidity - dapp-scratch - CLI for generating javascript modules from Contracts for Decentralized Apps. (Tools)
• awesome-solidity - dapp-scratch - CLI for generating javascript modules from Contracts for Decentralized Apps. (Tools)

README

        
# Dapp Scratch

A command line interface for generating a Javascript module for interacting with a Solidity contract.

## Tutorial

[Dapp Scratch: a CLI for Building Dapps (and tutorial for building your first one)](https://medium.com/@billyrennekamp/dapp-scratch-a-cli-for-building-dapps-and-tutorial-for-building-your-first-one-5cabdff3771e)

## install

```

npm install -g dapp-scratch

```

## run

```

$ dapp-scratch build 

$ dapp-scratch build  --address 0x1234567890123456789012345678901234567890

$ dapp-scratch build  --ABI './build/contracts/ContractName.json'

$ dapp-scratch build  --contract './contracts/ContractName.sol'

$ dapp-scratch test

$ dapp-scratch -h

  Usage: dapp-scratch build [options]

  Options:

    -V, --version              output the version number

    -c, --contract [contract]  Contract name or location

                                 ie: SampleContract or SampleContract.sol or ./contracts/SampleContract.sol

    -b, --abi [abi]            ABI name or location

                                 ie: SampleContract or SampleContract.json or ./build/contracts/SampleContract.json

    -a, --address [address]    Address of deployed contract

    -h, --help                 output usage information

  Commands:

    build   Build a module from Contract or ABI

    test    Generate a contract for testing

```

## results

```

$ dapp-scratch build SampleContract

Contract found at ./contracts/SampleContract.sol

web3 installed

web3-provider-engine installed

Module created at ./dapp-module/SampleContract/index.js

/*

 * To use SampleContract just import it into your project:

 */

const SampleContract = require('./dapp-module/SampleContract/index.js')

let sampleContract = new SampleContract()

sampleContract.helloWorld()

/*

 * Have Fun : )

 */

```

## develop

```

git clone [email protected]/okwme/dapp-scratch

cd dapp-scratch

npm install

npm run dev

```

## test

```

npm run test

```