Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs update #50

Merged
merged 20 commits into from
Nov 25, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updated deployment docs
shpookas committed Nov 25, 2024
commit e90be39939ba8b7da599a3fc982581db67397a7b
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -5,6 +5,30 @@ Thus obtained trades are then processed in a 2-step aggregation procedure in ord

![alt text](https://github.com/diadata-org/decentral-feeder/blob/master/assets/Feeder_Architecture_Small.jpg?raw=true)

---

## Table of Contents
1. [Detailed Description of the Building Blocks](#detailed-description-of-the-building-blocks)
- [Scrapers](#scrapers)
- [Collector](#collector)
- [Processor](#processor)
- [Feeder](#feeder)
2. [Node Deployment Guide](#node-deployment-guide)
- [Requirements](#requirements)
- [Docker Compose Deployment](#docker-compose-deployment)
- [1. Navigate to the Docker Compose Folder](#1-navigate-to-the-docker-compose-folder)
- [2. Configure Environment Variables](#2-configure-environment-variables)
- [3. Retrieve Deployed Contract](#3-retrieve-deployed-contract)
- [4. Run Docker Compose](#4-run-docker-compose)
- [Verification](#verification)
- [Alternative Deployment Methods](#alternative-deployment-methods)
- [Docker Run Deployment](#docker-run-deployment)
- [Kubernetes Deployment](#kubernetes-deployment)
- [Error Handling](#error-handling)
3. [Conclusion](#conclusion)

---

# Detailed Description of the Building Blocks
In the following, we describe function and usage of the constituting building blocks (see figure). We proceed from bottom to top.