Coder Social home page Coder Social logo

truffle's Introduction

npm npm Join the chat at https://gitter.im/consensys/truffle


Truffle is a development environment, testing framework and asset pipeline for Ethereum, aiming to make life as an Ethereum developer easier. With Truffle, you get:

  • Built-in smart contract compilation, linking, deployment and binary management.
  • Automated contract testing with Mocha and Chai.
  • Configurable build pipeline with support for custom build processes.
  • Scriptable deployment & migrations framework.
  • Network management for deploying to many public & private networks.
  • Interactive console for direct contract communication.
  • Instant rebuilding of assets during development.
  • External script runner that executes scripts within a Truffle environment.

Install

$ npm install -g truffle

Quick Usage

For a default set of contracts and tests, run the following within an empty project directory:

$ truffle init

From there, you can run truffle compile, truffle migrate and truffle test to compile your contracts, deploy those contracts to the network, and run their associated unit tests.

Truffle comes bundled with a local development blockchain server that launches automatically when you invoke the commands above. If you'd like to configure a more advanced development environment we recommend you install the blockchain server separately by running npm install -g ganache-cli at the command line.

  • ganache-cli: a command-line version of Truffle's blockchain server.
  • ganache: A GUI for the server that displays your transaction history and chain state.

See the documentation for more details.

Documentation

Please see the Official Truffle Documentation for guides, tips, and examples.

Contributing

This package is a distribution package of the Truffle command line tool. Please see truffle-core to contribute to the main core code.

License

MIT

truffle's People

Contributors

area avatar benjamincburns avatar captdaylight avatar cgewecke avatar chetan avatar fabioberger avatar federicobond avatar gnidan avatar harlantwood avatar jdmaresco avatar jeffanthony avatar jeffscottward avatar johndoe389 avatar johnmcdowall avatar jtremback avatar kp666 avatar larspensjo avatar logvinovleon avatar mpolci avatar oed avatar pamungkaski avatar raineorshine avatar robinboening avatar simondlr avatar skmgoldin avatar steelgander avatar tcoulter avatar vinay035 avatar wbt avatar xyzether avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.