Skip to content

README.md

Latest commit

 

History

History
79 lines (57 loc) · 3.64 KB

README.md

File metadata and controls

79 lines (57 loc) · 3.64 KB
Logo

Fuel Data Systems

Official data streaming libraries and tools for the Fuel Network.

CI Coverage

📦 Crates   🐛 Report Bug   ✨ Request Feature

📝 About The Project

Fuel Data Systems is a set of services to synchronize Fuel blockchain data with a data lake stored on S3 (or S3 compatible services).

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.

Getting Started

The CONTRIBUTING.md file contains detailed information about setting up your development environment and contributing to this project.

📚 Documentation

For codebase documentation, see the README files in the relevant directories:

📑 Architecture Components

Services

Service Description
Dune Service Processes blockchain data for analytics with Dune

Deployment and Infrastructure

Component Description
Cluster Deployment infrastructure and configuration
Docker Docker configuration for local development
Charts Helm charts for Kubernetes deployment
Scripts Utility scripts for development and deployment

🛠️ Development

For local development:


1. **Run Services**:
    - Dune Service: `make run-dune`

See the [CONTRIBUTING.md](CONTRIBUTING.md) for more detailed development instructions.

## 💪 Contributing

We welcome contributions! Please check our [contributing guidelines](CONTRIBUTING.md) for more information on how to get started.

## 📜 License

This project is licensed under the `Apache-2.0` license. See [`LICENSE`](./LICENSE) for more information.