Merge branch 'fraccaman/update-readme'

* fraccaman/update-readme:
  update readme

.env.template

@@ -0,0 +1 @@
+COMETBFT_URL=""

README.md

@@ -13,6 +13,11 @@ quickly, alleviating remote procedure calls to full nodes.
 
 ⚠️ This project is still a work-in-progress, use at your own risk! ⚠️
 
+## How to run
+
+- Copy the `.env.template` to `.env` file and edit the necessary variables.
+- Run `docker compose up`
+
 ## License
 
 This project is licensed under the GNU General Public License v3.0. You can

docker-compose.yml

@@ -15,7 +15,21 @@ services:
       timeout: 10s
       retries: 5
       start_period: 80s
-
+
+  block-index:
+    image: namada-masp-block-index
+    build:
+      context: .
+      dockerfile: block-index/Dockerfile
+    environment:
+      COMETBFT_URL: ${COMETBFT_URL}
+      DATABASE_URL: postgres://postgres:password@postgres:5432/masp_indexer_local
+    depends_on:
+      postgres:
+        condition: service_healthy
+    extra_hosts:
+      - "host.docker.internal:host-gateway"
+
   webserver:
     image: namada-masp-webserver
     build:
@@ -34,8 +48,7 @@ services:
       context: .
       dockerfile: chain/Dockerfile
     environment:
-      COMETBFT_URL: <>
-      CHAIN_ID: <>
+      COMETBFT_URL: ${COMETBFT_URL}
       DATABASE_URL: postgres://postgres:password@postgres:5432/masp_indexer_local
     depends_on:
       postgres: