Skip to content

Commit

Permalink
Update Indexer README
Browse files Browse the repository at this point in the history
  • Loading branch information
chenyaoy committed May 10, 2024
1 parent cffdb5f commit 31d418f
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions indexer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,22 @@ nvm alias default $(nvm version) # optional
npm i -g pnpm@6
```

Now, you can install dependencies for Indexer.
### Installation

Now, you can install dependencies for Indexer. This should also be run anytime packages are updated.

```
pnpm install
```

### Build
To build all of the services and packages, run:

```
pnpm run build:all
```
This should be run whenever code is changed and you need to deploy or run the updated code, including running unit tests, deploying locally, or deploying to AWS.

## Adding Packages

Use `packages/example-package` as a template:
Expand Down Expand Up @@ -78,7 +88,7 @@ Protos can be found in `proto/` [here](https://github.com/dydxprotocol/v4-chain/

## Running unit tests

First build all the services and packages by running:
First, make sure all of the services and packages are built with the latest code by running:

```
pnpm run build:all
Expand Down

0 comments on commit 31d418f

Please sign in to comment.