scaffold: generate docker-compose.yml when calling graph init (#1610)

* scaffold: generate docker-compose.yml when calling graph init

* feat: include the pre-release files

* Apply suggestions from code review

---------

Co-authored-by: Saihajpreet Singh <[email protected]>

Author: yehia67

.changeset/young-rockets-develop.md

@@ -0,0 +1,5 @@
+---
+'@graphprotocol/graph-cli': minor
+---
+
+Generate `docker-compose.yml` with `graph init` command

packages/cli/src/scaffold/get-docker-file.ts

@@ -0,0 +1,52 @@
+export const getDockerFile = () => {
+  return `version: '3'
+services:
+  graph-node:
+    image: graphprotocol/graph-node
+    ports:
+      - '8000:8000'
+      - '8001:8001'
+      - '8020:8020'
+      - '8030:8030'
+      - '8040:8040'
+    depends_on:
+      - ipfs
+      - postgres
+    extra_hosts:
+      - host.docker.internal:host-gateway
+    environment:
+      postgres_host: postgres
+      postgres_user: graph-node
+      postgres_pass: let-me-in
+      postgres_db: graph-node
+      ipfs: 'ipfs:5001'
+      ethereum: 'mainnet:http://host.docker.internal:8545'
+      GRAPH_LOG: info
+  ipfs:
+    image: ipfs/kubo:v0.17.0
+    ports:
+      - '5001:5001'
+    volumes:
+      - ./data/ipfs:/data/ipfs
+  postgres:
+    image: postgres:14
+    ports:
+      - '5432:5432'
+    command:
+      [
+        "postgres",
+        "-cshared_preload_libraries=pg_stat_statements",
+        "-cmax_connections=200"
+      ]
+    environment:
+      POSTGRES_USER: graph-node
+      POSTGRES_PASSWORD: let-me-in
+      POSTGRES_DB: graph-node
+      # FIXME: remove this env. var. which we shouldn't need. Introduced by
+      # <https://github.com/graphprotocol/graph-node/pull/3511>, maybe as a
+      # workaround for https://github.com/docker/for-mac/issues/6270?
+      PGDATA: "/var/lib/postgresql/data"
+      POSTGRES_INITDB_ARGS: "-E UTF8 --locale=C"
+    volumes:
+      - ./data/postgres:/var/lib/postgresql/data`;
+};

packages/cli/src/scaffold/index.ts

@@ -4,6 +4,7 @@ import { getSubgraphBasename } from '../command-helpers/subgraph';
 import Protocol from '../protocols';
 import ABI from '../protocols/ethereum/abi';
 import { version } from '../version';
+import { getDockerFile } from './get-docker-file';
 import { generateEventIndexingHandlers } from './mapping';
 import { abiEvents, generateEventType, generateExampleEntityType } from './schema';
 import { generateTestsFiles } from './tests';
@@ -154,6 +155,10 @@ dataSources:
     );
   }
 
+  async generateDockerFileConfig() {
+    return await prettier.format(getDockerFile(), { parser: 'yaml' });
+  }
+
   async generateMappings() {
     return this.protocol.getMappingScaffold()
       ? { [`${strings.kebabCase(this.contractName)}.ts`]: await this.generateMapping() }
@@ -208,6 +213,7 @@ dataSources:
       'subgraph.yaml': await this.generateManifest(),
       'schema.graphql': await this.generateSchema(),
       'tsconfig.json': await this.generateTsConfig(),
+      'docker-compose.yml': await this.generateDockerFileConfig(),
       src: await this.generateMappings(),
       abis: await this.generateABIs(),
       tests: await this.generateTests(),