Smart Contract Starter

Boilerplate for your next Smart Contract, made simple.

Show some :heart:

This project uses:

• Truffle v5
• Ganache
• Solium
• OpenZeppelin
• Travis CI and Circle CI
• Coveralls

Installation

1. Install Truffle and Ganache CLI globally.

npm install -g truffle@beta
npm install -g ganache-cli

2. Create a .env file in the root directory and add your private key.

Commands:

Compile contracts:                  truffle compile
Migrate contracts:                  truffle migrate
Test contracts:                     truffle test
Run eslint:                         npm run lint
Run solium:                         npm run solium
Run solidity-coverage:              npm run coverage
Run lint, solium, and truffle test: npm run test

Created & Maintained By

Ravindra Kumar (@ravidsrk)

If you found this repo helpful or you learned something from the source code and want to thank me, consider buying me a cup of :coffee:

License

MIT License

Copyright (c) 2018 Ravindra Kumar <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.