From bbbdf6751d042d1a5122f38c0dde0d50afe265a8 Mon Sep 17 00:00:00 2001 From: Daniel Sintimbrean <102896754+DanielSintimbrean@users.noreply.github.com> Date: Sat, 4 Nov 2023 15:57:43 +0100 Subject: [PATCH] docs: Add instructions for Docker setup --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b1b7ab1..6653632 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ # Mr. Crypto Indexer -## Get started +## Get started - Local + +### Clone repository + +```bash +git clone https://github.com/Racks-Community/MrCryptoIndexer +cd MrCryptoIndexer +``` ### Install dependencies @@ -27,6 +34,27 @@ pnpm build pnpm start ``` +## Get started - Docker + +### Clone repository + +```bash +git clone https://github.com/Racks-Community/MrCryptoIndexer +cd MrCryptoIndexer +``` + +### Copy `.env` file and complete it + +```bash +cp .env.example .env +``` + +### Docker compose up + +```bash +docker-compose up -d +``` + ## Folder structure ``` @@ -35,7 +63,7 @@ pnpm start │ ├── schema.prisma # Prisma schema │ └── seed.ts # Script to populate database └── src - ├── builder.ts + ├── builder.ts # GraphQL schema builder with Pothos ├── db.ts ├── indexer # Logic for indexing data │ ├── abis