search

erichaagdev / KappaBot

The derpiest chat bot of them all.
1 stars 1 forks source link

Suggestion: add a home page #25

Open ploober opened 4 years ago

ploober commented 4 years ago

When I navigate in my browser to http://localhost:8080/ I get a 404 white label error page (spring default).

While this error page doesn't really indicate that anything is wrong, it may give the wrong impression to a user who is setting up KappaBot. I am suggesting that we add a simple "it's working" style page that can be served instead, like what you get out of the box with most HTTP servers.

We could later also use this page for other things like a link to the Swagger docs, making that more discoverable. We could also dump out the list of commands on this page, or provide debugging information such as memory consumption, or listing all of the currently connected integrations. There are many interesting options of ways this space could be used.

erichaagdev commented 4 years ago

I really like this and I have actually thought about giving the bot a "face" so to speak. A place that can be used to display commands and other bot details, like you're saying. That would probably be a pretty large project and I am currently working on rewriting a lot of the "lower level" parts of the bot to make them more user friendly. For now, I could definitely either add an "it's working" page or I could even simply redirect the index page to /swagger-ui.html.

ploober commented 4 years ago

I'd be more in favor of a separate page. Maybe "It's working" + a link to Swagger.