Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update indexer README #1482

Merged
merged 3 commits into from
May 10, 2024
Merged

Update indexer README #1482

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5963e5b
Update Indexer README
chenyaoy May 8, 2024
76309d8
Update indexer/README.md
chenyaoy May 10, 2024
aab8ab6
Apply suggestions from code review
chenyaoy May 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions indexer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,23 @@ 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
chenyaoy marked this conversation as resolved.
Show resolved Hide resolved

To build all 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 +89,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 services and packages are built with the latest code by running:

```
pnpm run build:all
Expand Down
Loading