HeyHomie API

Installation

This API needs postgres database with 2 schemas:

• public (heyhomie old ruby database)
• go (new schema for api)

On the first run go schema will initialize and API will function

Dependencies

https://bun.sh/

bun install
go install honnef.co/go/tools/cmd/staticcheck@latest
go install github.com/swaggo/swag/v2/cmd/swag@latest

Docs

Docs available at swagger specification in debug mode, set GIN_MODE=debug in .env, then restart the server

Demo admin account

admin@example.com
changeme

Client generation

Requirements

Install https://openapi-generator.tech/docs/installation

npm install -g @openapitools/openapi-generator-cli

OpenAPI specifications

Build go api server to generate OpenAPI specifications, they will be located at docs/swagger/*.yaml

make build

Generate client files

Example javascript client generation

# list available clients
openapi-generator-cli list
# - javascript
# - javascript-closure-angular
# - javascript-flowtyped

# generate client
openapi-generator-cli generate -i docs/swagger/<spec>.yaml -g javascript -o <output dir>

runtime go1.23.4-linux-amd64

build git-acef7ec (2025/07/24 18:37:27)