Git Product home page Git Product logo

zos's Introduction

ZeppelinOS (zos)

standard-readme compliant CircleCI lerna

ZeppelinOS smart contract platform.

ZeppelinOS is a platform to develop, deploy and operate smart contract projects on Ethereum and every other EVM and eWASM-powered blockchain.

This repository includes the ZeppelinOS Command-Line Interface, JavaScript Library, and the sources for the Documentation Website.

Install

First, install Node.js and npm. Then, install ZeppelinOS running:

npm install --global zos

Usage

We recommend to use ZeppelinOS through the zos command-line interface.

To start, create a directory for the project and access it:

mkdir my-project
cd my-project

Use npm to create a package.json file:

npm init

And initialize the ZeppelinOS project:

zos init my-project

Now it is possible to add contracts to the project with the zos add command, push these contracts to a blockchain network with zos push, use zos create to create instances for these contracts that later can be upgraded, and many more things.

Run zos --help for more details about thes and all the other functions of ZeppelinOS.

The ZeppelinOS documentation explains how to build a project using our platform, how to upgrade contracts, how to share packages for other projects to reuse, how to vouch for the quality of a package, how to use the JavaScript libraries to operate the project, and it explains details of the platform and some advanced topics.

Security

If you find a security issue, please contact us at [email protected]. We give rewards for reported issues, according to impact and severity.

Maintainers

Development setup

Run npm install in the root of the project, followed by npx lerna bootstrap to have lerna install all dependencies in all packages and symlink them as needed.

Contribute

To contribute, join our forum or community channel on Telegram, where you can talk to all the ZeppelinOS developers, contributors, partners, and users.

You can also follow the recent developments of the project in our blog and Twitter account.

License

MIT © Zeppelin

zos's People

Contributors

3ach avatar arku avatar bakaoh avatar come-maiz avatar crazyrabbitltc avatar facuspagnuolo avatar fiiiu avatar frangio avatar hardlydifficult avatar jbcarpanelli avatar jeffanthony avatar maraoz avatar martriay avatar nventuro avatar paulinablaszk avatar paulrberg avatar pcowgill avatar perseverance avatar pinkiebell avatar protongustave avatar raucao avatar rrecuero avatar s1na avatar siromivel avatar spalladino avatar theethernaut avatar tinchoabbate avatar tsudmi avatar ylv-io avatar zumzoom avatar

Watchers

 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.