Skip to content

Commit

Permalink
docs: Add instructions for Docker setup
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielSintimbrean committed Nov 4, 2023
1 parent fc0ebbc commit bbbdf67
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

```
Expand All @@ -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
Expand Down

0 comments on commit bbbdf67

Please sign in to comment.