Skip to content

Commit 7f90135

Browse files
docs: add link local deps section and other README improvements
1 parent 9672055 commit 7f90135

File tree

1 file changed

+42
-27
lines changed

1 file changed

+42
-27
lines changed

README.md

+42-27
Original file line numberDiff line numberDiff line change
@@ -7,51 +7,66 @@ This is the Fetch ledger SubQuery project, an indexer for the Fetch network.
77

88
## Getting Started
99

10-
### 1. Ensure submodules are updated
10+
1. **Ensure submodules are updated**
1111

12-
```shell
13-
git submodule update --init --recursive
14-
```
12+
```shell
13+
git submodule update --init --recursive
14+
```
1515

16-
### 2. Install dependencies
16+
1. Install dependencies
1717

18-
```shell
19-
yarn
18+
```shell
19+
yarn
2020

21-
# install submodule dependencies
22-
(cd ./subql && yarn)
23-
```
21+
# install submodule dependencies
22+
(cd ./subql && yarn)
23+
```
2424

25-
### 3. Generate types
25+
1. Link local (non-workspace) dependencies
2626

27-
```shell
28-
yarn codegen
29-
```
27+
```shell
28+
# register non-workspace package for linking
29+
(cd ./docker/types-cosmos && yarn link)
30+
31+
# link to repo package (ledger-subquery)
32+
yarn link @subql/types-cosmos
33+
```
34+
35+
1. Generate types
3036

31-
### 4. Build
37+
```shell
38+
yarn codegen
39+
```
3240

33-
```shell
34-
yarn build
41+
1. Build
3542

36-
# build submodule
37-
(cd ./subql && yarn build)
38-
```
43+
```shell
44+
yarn build
3945

40-
### 5. Run locally
46+
# build submodule
47+
(cd ./subql && yarn build)
48+
```
4149

42-
```shell
43-
yarn start:docker
44-
```
50+
1. Run locally
51+
52+
```shell
53+
yarn start:docker
54+
```
4555

4656
## End-to-end Testing
4757

48-
### 1. Install dependencies
58+
### Installing python dependencies
4959

5060
```shell
51-
pipenv install
61+
# ensure pipenv is installed
62+
pip install --user pipenv
63+
# (see: https://pipenv.pypa.io/en/latest/index.html)
64+
65+
# ensure local dependencies match Pipfile.lock
66+
pipenv sync --dev
5267
```
5368

54-
### 2. Run e2e tests
69+
### Run e2e tests
5570

5671
_Note: end-to-end tests will truncate tables in the DB and interact with the configured fetchd node._
5772

0 commit comments

Comments
 (0)