This repository contains proprietary code to process captured Civil contract events and persists the processed data down for use via APIs. It is written in golang.
This project is using make to run setup, builds, tests, etc and has been tested and running on go 1.12.7.
Ensure that your $GOPATH and $GOROOT are setup properly in your shell configuration and that this repo is cloned into the appropriate place in the $GOPATH. i.e. $GOPATH/src/github.com/joincivil/civil-events-processor/
To setup the necessary requirements:
make setup
Relies on dephttps://golang.github.io/dep/ for dependency management, updating the /vendor/ directory in the project.
When adding and removing imports, make sure to run dep ensure. Any adding or removing will require committing the updates on Gopkg.lock and /vendor/ to the repository.
Check all the packages for linting errors using a variety of linters via golangci-lint. Check the Makefile for the up to date list of linters.
make lint
make build
Runs the tests and checks code coverage across the project. Produces a coverage.txt file for use later.
make test
Run make test and launches the HTML code coverage tool.
make cover
The processor relies on environment vars for configuration. To configure locally, edit the .env file included in the repo to what is needed.
To run the service:
go run cmd/processor/main.go
To find all the available configuration environment vars:
go run cmd/processor/main.go -h