wormhole-explorer/api
Mariano 5d27910bca remove unnecessary break 2024-04-26 11:25:53 -03:00
..
cacheable
docs update endpoint name 2024-04-26 09:55:48 -03:00
handlers remove unnecessary break 2024-04-26 11:25:53 -03:00
internal
middleware change endpoint signature 2024-04-26 09:55:48 -03:00
response
routes update endpoint name 2024-04-26 09:55:48 -03:00
rpc
.gitignore
Dockerfile
Makefile
README.md
go.mod Fix go dependencies in api and pipeline (#1344) 2024-04-23 11:41:06 -03:00
go.sum Fix go dependencies in api and pipeline (#1344) 2024-04-23 11:41:06 -03:00
main.go

README.md

API

How to build

make build

Config

You will need to set some env variables with the prefix WORMSCAN

  • WORMSCAN_DB_MONGO
  • WORMSCAN_DB_NAME
  • WORMSCAN_PORT

for example:

WORMSCAN_DB_URL=mongodb://localhost:27017/wormhole WORMSCAN_DB_NAME=wormhole WORMSCAN_PORT=5555 WORMSCAN_RUNMODE=DEVELOPMENT ./api

API Documentation

Documentation is automagically generated via swaggo using annotations on code and placed inside doc/ folder.

To install swag tool run this

go install github.com/swaggo/swag/cmd/swag@latest

To generate or update the doc run:

make doc