idle-fantasy-story

module
v0.0.0-...-12cc501 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 1, 2024 License: MIT

README

CI Go Report Card

idle-fantasy-story

This is meant to be a service that generates a random fantasy story. It will stream the story to all clients.

Env vars

Name Description Default
API_PORT Port to listen to 8080
API_LOG_FORMATTER Log formatter to use. Can be json or text. json
API_LOG_LEVEL Log level to use info
API_MEMORYSTORAGE_WORLDSFILEPATH Path to the file that contains the worlds init/storage/inmemory/worlds.yml

Start the service

To start the server you can use make:

make run

You can also use env vars to modify the behaviour of the server like this:

API_PORT=3000 API_LOG_FORMATTER=json API_LOG_LEVEL=info make run

Call the GRPC endpoints

You can use the grpcurl tool to call the endpoints.

This way you can discover the grpc endpoints:

grpcurl -plaintext localhost:8080 list  

And you can call the endpoints like this:

grpcurl -plaintext -d '{}' localhost:8080 idlefantasystory.v1.StoryService/GetWorlds

Jump to

Keyboard shortcuts

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