diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 54 |
1 files changed, 30 insertions, 24 deletions
@@ -11,43 +11,43 @@ This repository contains all the 0x developer tools written in TypeScript. Our h [](https://circleci.com/gh/0xProject/0x.js) [](https://coveralls.io/github/0xProject/0x.js?branch=master) -[](https://chat.0xproject.com) +[](https://chat.0xproject.com) [](https://gitter.im/0xProject/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://opensource.org/licenses/Apache-2.0) [](https://greenkeeper.io/) ### Published Packages -| Package | Version | Description | -|---------|---------|-------------| -| [`0x.js`](/packages/0x.js) | [](https://www.npmjs.com/package/0x.js) | A Javascript library for interacting with the 0x protocol | -| [`@0xproject/abi-gen`](/packages/abi-gen) | [](https://www.npmjs.com/package/@0xproject/abi-gen) | Tool to generate TS wrappers from smart contract ABIs | -| [`@0xproject/assert`](/packages/assert) | [](https://www.npmjs.com/package/@0xproject/assert) | Type and schema assertions used by our packages | -| [`@0xproject/connect`](/packages/connect) | [](https://www.npmjs.com/package/@0xproject/connect) | A Javascript library for interacting with the standard relayer api | -| [`@0xproject/json-schemas`](/packages/json-schemas) | [](https://www.npmjs.com/package/@0xproject/json-schemas) | 0x-related json schemas | -| [`@0xproject/subproviders`](/packages/subproviders) | [](https://www.npmjs.com/package/@0xproject/subproviders) | Useful web3 subproviders (e.g LedgerSubprovider) | -| [`@0xproject/tslint-config`](/packages/tslint-config) | [](https://www.npmjs.com/package/@0xproject/tslint-config) | Custom 0x development TSLint rules | -| [`@0xproject/types`](/packages/types) | [](https://www.npmjs.com/package/@0xproject/types) | Shared type declarations | -| [`@0xproject/utils`](/packages/utils) | [](https://www.npmjs.com/package/@0xproject/utils) | Shared utilities | -| [`@0xproject/web3-wrapper`](/packages/web3-wrapper) | [](https://www.npmjs.com/package/@0xproject/web3-wrapper) | Web3 wrapper | +| Package | Version | Description | +| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | +| [`0x.js`](/packages/0x.js) | [](https://www.npmjs.com/package/0x.js) | A Javascript library for interacting with the 0x protocol | +| [`@0xproject/abi-gen`](/packages/abi-gen) | [](https://www.npmjs.com/package/@0xproject/abi-gen) | Tool to generate TS wrappers from smart contract ABIs | +| [`@0xproject/assert`](/packages/assert) | [](https://www.npmjs.com/package/@0xproject/assert) | Type and schema assertions used by our packages | +| [`@0xproject/connect`](/packages/connect) | [](https://www.npmjs.com/package/@0xproject/connect) | A Javascript library for interacting with the standard relayer api | +| [`@0xproject/json-schemas`](/packages/json-schemas) | [](https://www.npmjs.com/package/@0xproject/json-schemas) | 0x-related json schemas | +| [`@0xproject/subproviders`](/packages/subproviders) | [](https://www.npmjs.com/package/@0xproject/subproviders) | Useful web3 subproviders (e.g LedgerSubprovider) | +| [`@0xproject/tslint-config`](/packages/tslint-config) | [](https://www.npmjs.com/package/@0xproject/tslint-config) | Custom 0x development TSLint rules | +| [`@0xproject/types`](/packages/types) | [](https://www.npmjs.com/package/@0xproject/types) | Shared type declarations | +| [`@0xproject/utils`](/packages/utils) | [](https://www.npmjs.com/package/@0xproject/utils) | Shared utilities | +| [`@0xproject/web3-wrapper`](/packages/web3-wrapper) | [](https://www.npmjs.com/package/@0xproject/web3-wrapper) | Web3 wrapper | ### Private Packages -| Package | Description | -|---------|-------------| -| [`@0xproject/contracts`](/packages/contracts) | 0x solidity smart contracts & tests | -| [`@0xproject/kovan_faucets`](/packages/kovan-faucets) | A faucet micro-service that dispenses test ERC20 tokens or Ether | -| [`@0xproject/monorepo-scripts`](/packages/monorepo-scripts) | Shared monorepo scripts | -| [`@0xproject/website`](/packages/website) | 0x website & Portal DApp | +| Package | Description | +| ----------------------------------------------------------- | ---------------------------------------------------------------- | +| [`@0xproject/contracts`](/packages/contracts) | 0x solidity smart contracts & tests | +| [`@0xproject/kovan_faucets`](/packages/kovan-faucets) | A faucet micro-service that dispenses test ERC20 tokens or Ether | +| [`@0xproject/monorepo-scripts`](/packages/monorepo-scripts) | Shared monorepo scripts | +| [`@0xproject/website`](/packages/website) | 0x website & Portal DApp | ## Usage Dedicated documentation pages: -- [0x.js Library](https://0xproject.com/docs/0xjs) -- [0x Connect](https://0xproject.com/docs/connect) -- [Smart contracts](https://0xproject.com/docs/contracts) -- [Standard Relayer API](https://github.com/0xProject/standard-relayer-api/blob/master/README.md) + +* [0x.js Library](https://0xproject.com/docs/0xjs) +* [0x Connect](https://0xproject.com/docs/connect) +* [Smart contracts](https://0xproject.com/docs/contracts) +* [Standard Relayer API](https://github.com/0xProject/standard-relayer-api/blob/master/README.md) ## Contributing @@ -58,11 +58,13 @@ Please read our [contribution guidelines](./CONTRIBUTING.md) before getting star ### Install dependencies If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them: + ```bash yarn config set workspaces-experimental true ``` Then install dependencies + ```bash yarn install ``` @@ -78,6 +80,7 @@ yarn lerna:run build ### Lint Lint all packages + ```bash yarn lerna:run lint ``` @@ -87,11 +90,13 @@ yarn lerna:run lint Before running the tests, you will need to spin up a [TestRPC](https://www.npmjs.com/package/ethereumjs-testrpc) instance and deploy all the 0x smart contracts. In a separate terminal, start TestRPC (a convenience command is provided as part of this repo) + ```bash yarn testrpc ``` Then in your main terminal run + ``` cd packages/contracts yarn migrate @@ -99,6 +104,7 @@ cd .. ``` And finally from the root project directory run + ```bash yarn lerna:run test ``` |