|
| 1 | +<div align="center"> |
| 2 | + <a href="https://github.com/fuellabs/data-systems"> |
| 3 | + <img src="https://fuellabs.notion.site/image/https%3A%2F%2Fprod-files-secure.s3.us-west-2.amazonaws.com%2F9ff3607d-8974-46e8-8373-e2c96344d6ff%2F81a0a0d9-f3c7-4ccb-8af5-40ca8a4140f9%2FFUEL_Symbol_Circle_Green_RGB.png?table=block&id=cb8fc88a-4fc3-4f28-a974-9c318a65a2c6&spaceId=9ff3607d-8974-46e8-8373-e2c96344d6ff&width=2000&userId=&cache=v2" alt="Logo" width="80" height="80"> |
| 4 | + </a> |
| 5 | + <h3 align="center">Fuel Data Systems</h3> |
| 6 | + <p align="center"> |
| 7 | + Official data streaming libraries and tools for the Fuel Network. |
| 8 | + </p> |
| 9 | + <p align="center"> |
| 10 | + <a href="https://github.com/FuelLabs/data-systems/actions/workflows/ci.yaml" style="text-decoration: none;"> |
| 11 | + <img src="https://github.com/FuelLabs/data-systems/actions/workflows/ci.yaml/badge.svg?branch=main" alt="CI"> |
| 12 | + </a> |
| 13 | + <a href="https://codecov.io/gh/FuelLabs/data-systems" style="text-decoration: none;"> |
| 14 | + <img src="https://codecov.io/gh/FuelLabs/data-systems/graph/badge.svg?token=1zna00scwj" alt="Coverage"> |
| 15 | + </a> |
| 16 | + </p> |
| 17 | + <p align="center"> |
| 18 | + <a href="https://github.com/fuellabs/data-systems/tree/main/crates">📦 Crates</a> |
| 19 | + <span> </span> |
| 20 | + <a href="https://github.com/fuellabs/data-systems/issues/new?labels=bug&template=bug-report---.md">🐛 Report Bug</a> |
| 21 | + <span> </span> |
| 22 | + <a href="https://github.com/fuellabs/data-systems/issues/new?labels=enhancement&template=feature-request---.md">✨ Request Feature</a> |
| 23 | + </p> |
| 24 | +</div> |
| 25 | + |
| 26 | +## 📝 About The Project |
| 27 | + |
| 28 | +Fuel Data Systems is a set of services to syncronize Fuel blockchain data with a data lake stored on S3 (or S3 compatible services). |
| 29 | + |
| 30 | +With Fuel Data Systems, developers can build sophisticated applications that leverage the full potential of the Fuel Network's data, from simple block explorers to complex analytics engines and trading systems. |
| 31 | + |
| 32 | +### Getting Started |
| 33 | + |
| 34 | +The [CONTRIBUTING.md](CONTRIBUTING.md) file contains detailed information about setting up your development environment and contributing to this project. |
| 35 | + |
| 36 | +## 📚 Documentation |
| 37 | + |
| 38 | +For codebase documentation, see the README files in the relevant directories: |
| 39 | + |
| 40 | +- [Crates Documentation](crates/) |
| 41 | +- [Services Documentation](services/) |
| 42 | +- [Cluster Documentation](cluster/) |
| 43 | + |
| 44 | +## 📑 Architecture Components |
| 45 | + |
| 46 | +### Services |
| 47 | + |
| 48 | +| Service | Description | |
| 49 | +| ------------------------------------------------- | ---------------------------------------------------------------- | |
| 50 | +| [Dune Service](services/dune/README.md) | Processes blockchain data for analytics with Dune | |
| 51 | + |
| 52 | +### Deployment and Infrastructure |
| 53 | + |
| 54 | +| Component | Description | |
| 55 | +| ---------------------------------- | ---------------------------------------------- | |
| 56 | +| [Cluster](cluster/README.md) | Deployment infrastructure and configuration | |
| 57 | +| [Docker](cluster/docker/README.md) | Docker configuration for local development | |
| 58 | +| [Charts](cluster/charts/README.md) | Helm charts for Kubernetes deployment | |
| 59 | +| [Scripts](scripts/README.md) | Utility scripts for development and deployment | |
| 60 | + |
| 61 | +## 🛠️ Development |
| 62 | + |
| 63 | +For local development: |
| 64 | + ``` |
| 65 | + |
| 66 | +1. **Run Services**: |
| 67 | + - Dune Service: `make run-dune` |
| 68 | + |
| 69 | +See the [CONTRIBUTING.md](CONTRIBUTING.md) for more detailed development instructions. |
| 70 | + |
| 71 | +## 💪 Contributing |
| 72 | + |
| 73 | +We welcome contributions! Please check our [contributing guidelines](CONTRIBUTING.md) for more information on how to get started. |
| 74 | + |
| 75 | +## 📜 License |
| 76 | + |
| 77 | +This project is licensed under the `Apache-2.0` license. See [`LICENSE`](./LICENSE) for more information. |
0 commit comments