blockchain-api

module

v0.0.0-...-335c537 Latest Latest Go to latest Published: Dec 13, 2021 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

README ¶

Github CI/CD Repository Top Language Scrutinizer Code Quality GitHub go.mod Go version Codacy Grade Github Repository Size Github Open Issues Lines of code GitHub last commit GitHub contributors

Blockchain API

API-server for blockchain indexes

Solution notes

🔱 clean architecture (handler->service->repository)
📖 standard Go project layout (well, more or less 😊)
💿 github CI/CD + docker compose + Makefile included
✅ handler tests with mocks included
❤ Swagger auto-generated on make generate included

HOWTO

🏃♂ run app in docker-compose with make dc
🧪 run tests with make test
🪙 generate contract from abi file with make abigen
🌻 run linter with make lint

A picture is worth a thousand words

Directories ¶

Path	Synopsis
cmd
app Package classification Blockchain API.	Package classification Blockchain API.
config
internal
abi
app/handlers/ctx
app/handlers/handlerblock Package handlerblock is a generated GoMock package.	Package handlerblock is a generated GoMock package.
app/handlers/handlergroup Package handlergroup is a generated GoMock package.	Package handlergroup is a generated GoMock package.
app/handlers/handlerindex Package handlerindex is a generated GoMock package.	Package handlerindex is a generated GoMock package.
app/services/serviceblock Package serviceblock is a generated GoMock package.	Package serviceblock is a generated GoMock package.
app/services/servicegroup Package servicegroup is a generated GoMock package.	Package servicegroup is a generated GoMock package.
app/services/serviceindex Package serviceindex is a generated GoMock package.	Package serviceindex is a generated GoMock package.
pkg/contract
pkg/models

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL