There are some files that should probably be git-ignored:

packages/subgraph/abis/BatchRegistry.json Is "copied" by packages/subgraph/scripts/abi_copy.ts
So if that file is going to be autogenerated:

1. we should not edit it manually
2. we should not track any version of it (its automatically copied by a script)

packages/subgraph/subgraph.yaml is also autogenerated by /prepare-local-manifest.ts parsing subgraph.template.yaml

Appart from that the graph local DX could be improved:

Improve root README.md

Our main readme assumes knowledge of how to run the repo, but we should explicitly state how to run the repo.
Basic flow is specified in issue #12
We also need to add the steps to run a local graph node (and deploy the subgraph locally):
0.1 $ yarn chain runs a local node with hardhat
0.2 $ yarn deploy deploy our contracts on local node

1. $ yarn subgraph:clean-node cleans prev data (we will run and deploy everything from scratch)
2. $ yarn subgraph:run-node spins up a local graph node (analogous to yarn chain)
3. $ yarn subgraph:local-create Compiles the subgraph
4. $ yarn subgraph:local-ship Deploys the subgraph on our local graph node
5. $ yarn subgraph:stop-node Stops our node (once we finsish developing)

The above instructions are a draft I made. But it lacks:

• dependency installations
• Other Pre-requisites: we need node, we need yarn, we need docker

Improve 00_deploy_your_contract.ts (or create another deploy script file)

Only for our local graph development it would be nice to have some random builders checkd in.
This would allow us to query them via our subgraph.
Without this, its difficult to be sure our subgraph works as expected.

⚠️ Buidl Guidl team might not want us to include a contract that shows how to do a checkIn.

A way to overcome this could be:

1. Have the CheckIn.sol (or whatever name) contract gitignored
2. Describing the function name that our deploy script will use (just the name)
3. Use it in our script (and having an error log in the script if the file is not there)

Creating a .env.local

This env could be commited and should not include any sensitive key.
The only value I would add to it for the moment would be:

NEXT_PUBLIC_SUBGRAPH_URL='http://localhost:8000/subgraphs/name/buidlguidl/batch23-subgraph'

So local development enviroment hits our local subgraph (and we avoid rate-limiting our deployed subgraph)