proxima-data-vertex

README

Data Vertex

The data vertex handles the requests, updates and maintenance of the decentralized application data index. Developers create data vertices to aggregate, transform and serve indexed data from a blockchain datasource.

Quick Start

For further information and functionality look at the proxima command-line interface.

Requirements

• node
• docker
• docker compose
• go
• git

Installation

git clone https://github.com/proxima-one/data-vertex.git

Set-up

The data vertex needs to be set-up such that the database config, the resolvers, and the schema match the requirements of the specified vertex. This is done automatically through the Proxima CLI.

Running

Before the data vertex can be run, it must have a docker-compose file that includes the database, the data vertex, and the data aggregator.

docker-compose up

The data vertex should be running on: 0.0.0.0:4000

Testing

go test

Benchmarking

To be implemented

Contributing

Read below to learn how you can take part in improving our project.

Code of Conduct

We have adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes.

Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

Licensing

This project is licensed under MIT licensing guidelines.