README.md

Gofiftyville

Fiftyville API written in Go.

Report Bug · Request Feature · Ask Question

API Endpoints

The list of valid api endpoints are available at the docs.

Developing Locally

Running the server

go run ./cmd/server

You can access the server at localhost:8080/api/v1/:endpoint.

Using Docker

1. Supply the environment variables

cp .env.example .env

2. Run docker compose

docker-compose up -d

You can access the server at localhost/api/v1/:endpoint or localhost:8080/api/v1/:endpoint.