feat: static html support (#243)

wolf31o2 · web-flow · commit 541501d0ca04 · 2024-10-04T10:24:57.000-04:00
Signed-off-by: Chris Gianelloni &lt;wolf31o2@blinklabs.io&gt;
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -2,4 +2,5 @@
 #
 * @blinklabs-io/core
 *.md @blinklabs-io/core @blinklabs-io/pms
+internal/api/static/* @blinklabs-io/core @blinklabs-io/frontend
 LICENSE @blinklabs-io/core @blinklabs-io/pms
diff --git a/internal/api/api.go b/internal/api/api.go
@@ -15,8 +15,11 @@
 package api
 
 import (
+	"embed"
 	"fmt"
 	"io"
+	"io/fs"
+	"net/http"
 	"time"
 
 	ouroboros "github.com/blinklabs-io/gouroboros"
@@ -34,16 +37,18 @@ import (
 	"github.com/blinklabs-io/tx-submit-api/submit"
 )
 
-//	@title			tx-submit-api
-//	@version		v0
-//	@description	Cardano Transaction Submit API
-//	@Schemes		http
-//	@BasePath		/
-
-//	@contact.name	Blink Labs
-//	@contact.url	https://blinklabs.io
-//	@contact.email	support@blinklabs.io
+//go:embed static
+var staticFS embed.FS
 
+// @title			tx-submit-api
+// @version		v0
+// @description	Cardano Transaction Submit API
+// @Schemes		http
+// @BasePath		/
+// @contact.name	Blink Labs
+// @contact.url	https://blinklabs.io
+// @contact.email	support@blinklabs.io
+//
 // @license.name	Apache 2.0
 // @license.url	http://www.apache.org/licenses/LICENSE-2.0.html
 func Start(cfg *config.Config) error {
@@ -71,6 +76,18 @@ func Start(cfg *config.Config) error {
 	}))
 	router.Use(ginzap.RecoveryWithZap(accessLogger, true))
 
+	// Configure static route
+	fsys, err := fs.Sub(staticFS, "static")
+	if err != nil {
+		return err
+	}
+	router.StaticFS("/ui", http.FS(fsys))
+	// Redirect from root
+	router.GET("/", func(c *gin.Context) {
+		c.Request.URL.Path = "/ui"
+		router.HandleContext(c)
+	})
+
 	// Create a healthcheck (before metrics so it's not instrumented)
 	router.GET("/healthcheck", handleHealthcheck)
 	// Create a swagger endpoint (not instrumented)
@@ -121,10 +138,9 @@ func Start(cfg *config.Config) error {
 	router.GET("/api/hastx/:tx_hash", handleHasTx)
 
 	// Start API listener
-	err := router.Run(fmt.Sprintf("%s:%d",
+	return router.Run(fmt.Sprintf("%s:%d",
 		cfg.Api.ListenAddress,
 		cfg.Api.ListenPort))
-	return err
 }
 
 func handleHealthcheck(c *gin.Context) {
diff --git a/internal/api/static/index.html b/internal/api/static/index.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+<title>Tx Submit API</title>
+</head>
+<body>
+<p align="center">
+<img src="txsubmit-logo.png" />
+</p>
+<p align="center">
+GitHub: <a href="https://github.com/blinklabs-io/tx-submit-api">https://github.com/blinklabs-io/tx-submit-api</a>
+</p>
+</body>
+</html>
diff --git a/internal/api/static/txsubmit-logo.png b/internal/api/static/txsubmit-logo.png

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,5 @@`
`2`	`2`	`#`
`3`	`3`	`* @blinklabs-io/core`
`4`	`4`	`*.md @blinklabs-io/core @blinklabs-io/pms`
	`5`	`+internal/api/static/* @blinklabs-io/core @blinklabs-io/frontend`
`5`	`6`	`LICENSE @blinklabs-io/core @blinklabs-io/pms`