Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 1.49 KB

README.md

File metadata and controls

64 lines (42 loc) · 1.49 KB

event-tracker

Description

Service that track events emitted by the specified Solidity contract

Install

git clone event-tracker
cd event-tracker
go build main.go
export KV_VIPER_FILE=./config.yaml
./main migrate up
./main run service

Documentation

We do use openapi:json standard for API. We use swagger for documenting our API.

To open online documentation, go to swagger editor here is how you can start it

  cd docs
  npm install
  npm start

To build documentation use npm run build command, that will create open-api documentation in web_deploy folder.

To generate resources for Go models run ./generate.sh script in root folder. use ./generate.sh --help to see all available options.

Running from docker

Make sure that docker installed.

docker build -t event-tracker .
docker run -e KV_VIPER_FILE=/config.yaml event-tracker

Running from Source

  • Set up environment value with config file path KV_VIPER_FILE=./config.yaml
  • Provide valid config file
  • Launch the service with migrate up command to create database schema
  • Launch the service with run service command

Database

For services, we do use PostgresSQL database. You can install it locally or use docker image.

Third-party services

Contact

Responsible Max Slobodzian The primary contact for this project is t.me/slbmax