protocol/packages/deployer/README.md

@0xproject/deployer

This repository contains a CLI tool that facilitates compiling and deployment of smart contracts.

Read the Documentation.

Installation

CLI Installation

npm install @0xproject/deployer -g

API Installation

npm install @0xproject/deployer --save

Import

import { Deployer, Compiler } from '@0xproject/deployer';

or

var Deployer = require('@0xproject/deployer').Deployer;
var Compiler = require('@0xproject/deployer').Compiler;

Contributing

We strongly recommend that the community help us make improvements and determine the future direction of the protocol. To report bugs within this package, please create an issue in this repository.

Please read our contribution guidelines before getting started.

Install Dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

yarn config set workspaces-experimental true

Then install dependencies

yarn install

Build

yarn build

or

yarn build:watch

Lint

yarn lint

Run Tests

yarn test