react-docs-example

@0xproject/react-docs-example

An example documentation page built using react-docs rendering the @0xproject/web3-wrapper Typescript package. This is a great starter project for hosting your own Solidity or Typescript documentation page.

Usage

This package is intended as a boilerplate for creating and hosting your own documentation page. Easiest way to get started is to fork the 0x-monorepo and start modifying react-docs-example.

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

Initial setup

The first time you work with this package, you must build all packages within the monorepo. This is because packages that depend on other packages located inside this monorepo are symlinked when run from within the monorepo. This allows you to make changes across multiple packages without first publishing dependent packages to NPM. To build all packages, run the following from the monorepo root directory:

yarn lerna:rebuild

Note: If you move this package out of the monorepo, it will work without this step. Make sure you copy it out on the master branch since the development version might rely on not-yet published changes to other packages.

Run dev server

The the react-docs-example root directory, run:

yarn dev

Deploy Example to S3 bucket

You will need to adapt the deploy_example command in the package.json to point to an S3 bucket you've created. Make sure the bucket is publicly accessible to everyone.

You will also need to install the aws-cli and configure it with your AWS credentials.

yarn deploy_example

Build

yarn build

Clean

yarn clean

Lint

yarn lint

Contributing

We strongly encourage the community to help us make improvements. To report bugs within this package, please create an issue in this repository.

Please read our contribution guidelines before getting started.