Merge pull request #27 from nilotpaul/cli

feat(template): new option & docs of seperate frontend as rendering strategy

Author: nilotpaul

README.md

@@ -57,33 +57,19 @@ Read detailed usage and examples of every stack configured.
 - [Go + Echo + Templates](/docs/go-echo-templates.md)
 - [Go + Fiber + Templates](/docs/go-fiber-templates.md)
 - [Go + Chi + Templates](/docs/go-chi-templates.md)
+- [Go + Seperate Client](/docs/go-seperate-client.md)
 
 **(Others)**
 - [Development Usage](/docs/development-usage.md)
 - [Recommendations](/docs/recommendations/index.md)
 
 # Configuration Options
 
-**Web Framework**
-- Echo  
-- Fiber
-- Chi
-
-**Styling**
-- Vanilla  
-- Tailwind
-
-**UI Library** 
-- Preline  
-- DaisyUI
-
-**Extra Options**
-- HTMX  
-- Dockerfile
+The configuration options include settings from various web frameworks to different rendering modes. For a detailed list, please check the [Configuration Options Docs](/docs/configuration.md).
 
 # Coming Soon
 
 - More Framework Options.
-- Different Rendering Strategies (seperate client, [templ](https://templ.guide)).
+- Different Rendering Strategies (~~seperate client~~, [templ](https://templ.guide)).
 - More examples and documentation.
 - Please suggest More 🙏🏼

cli.go

@@ -67,7 +67,7 @@ func init() {
 	)
 	initCmd.Flags().StringVar(
 		&stackConfig.RenderingStrategy, "render", "",
-		strings.Join(config.RenderingStrategy, ", "),
+		strings.Join(util.GetRenderingOpts(true), ", "),
 	)
 	initCmd.Flags().StringSliceVar(
 		&stackConfig.ExtraOpts, "extra", []string{},

command.go

@@ -67,7 +67,7 @@ func handleInitCmd(cmd *cobra.Command, args []string) {
 		return
 	}
 
-	util.PrintSuccessMsg(targetPath.Path)
+	util.PrintSuccessMsg(targetPath.Path, cfg)
 }
 
 // handleVersionCmd handles the `version` command for gospur CLI.

config/config.go

@@ -38,8 +38,9 @@ var (
 		"Preline": {"Tailwind"},
 		"DaisyUI": {"Tailwind"},
 	}
-	RenderingStrategy = []string{
-		"Templates",
+	RenderingStrategy = map[string]string{
+		"Templates":                        "Templates",
+		"Seperate Client (eg. react,etc.)": "Seperate",
 	}
 
 	// Flags Only
@@ -70,9 +71,10 @@ var (
 	// Template path is not required anymore for pages.
 	// We're processing these as raw files.
 	ProjectPageFiles = map[string]string{
-		"web/Home.html":         "",
-		"web/Error.html":        "",
-		"web/layouts/Root.html": "",
+		"web/Home.html":           "",
+		"web/Error.html":          "",
+		"web/layouts/Root.html":   "",
+		"web/dist/instruction.md": "",
 	}
 
 	ProjectAPIFiles = map[string][]string{

docs/configuration.md

@@ -0,0 +1,52 @@
+# Configuration Options
+
+> To see the available options, run gopsur init -h. The output will list all valid options, and their exact casing must be used (e.g., if an option is displayed as HTMX, it must be passed as HTMX).
+
+## For init command
+
+These will be asked as prompts when you run `init`. If an option is selected by a flag, it'll skip that prompt.
+
+**Web Framework**
+- Echo  
+- Fiber
+- Chi
+```sh
+# flag
+--framework Echo
+```
+
+**Rendering Strategy**
+- Templates  
+- Seperate Client (eg. react,svelte,etc.)
+```sh
+# flag
+--render Seperate
+```
+
+**Styling**
+- Vanilla  
+- Tailwind
+```sh
+# flag
+--styling Tailwind
+```
+
+**UI Library** 
+- Preline  
+- DaisyUI
+```sh
+# flag
+--ui DaisyUI
+```
+
+## Options via Flags
+
+These options can only be enabled/used via flags.
+
+**Extra Options**
+- HTMX  
+- Dockerfile
+```sh
+# flag
+--extra Dockerfile
+```

docs/go-seperate-client.md

@@ -0,0 +1,78 @@
+# Setting Up Your Frontend
+
+You have two options for integrating your frontend with the Go backend:
+
+1. Keep frontend inside this repo
+
+- Create your frontend project inside the `web` folder.
+- Do not modify `web/dist` directly - Go requires it to exist.
+- Configure your frontend to output static files to `web/dist`, replacing the default one.
+- If your build output directory is not `dist`, update it in `build_prod.go`.
+
+2. Keep frontend in a separate repo
+
+- Build the frontend in a CI pipeline (examples given below).
+- Merge the generated `dist` folder into `web/dist`.
+
+## Examples
+- [Basic Github Actions](#)
+- [Docker Github Actions](#)
+- [Dockerfile](#)
+
+> **TODO: will update later.**
+
+# Serving a Separate Frontend with Go
+
+Frontend frameworks like React, Vue, Svelte, etc. generate static assets (HTML, CSS, JS), which can be served directly from a Go backend. This simplifies deployment and avoids CORS issues.
+
+# How It Works
+
+- The frontend build (`build`/`dist` folder) is embedded in Go using `embed.FS`.
+- If a requested file exists, it's served normally.
+- If not, Go serves `index.html` (for SPAs) or a dedicated error page if available (for SSGs).
+
+# SPA vs. SSG Behavior
+
+- **SPA (Single Page App)**: Always fallbacks to `index.html`, and routing/errors are handled in JavaScript.
+- **SSG (Static Site Generation)**: If a `404.html` or similar page exists, serve that instead of `index.html`.
+
+# Configuring Fallback Pages (if needed)
+
+Some SSG frameworks may generate a `404.html` for handling missing pages. To serve it properly:
+
+**Echo Example**
+```go
+// Todo: will fix this later. Echo doesn't have an option to specify a fallback.
+e.Use(middleware.StaticWithConfig(middleware.StaticConfig{
+	Root:         "web/dist",
+	Index:        "index.html",
+	Filesystem:   http.FS(web),
+}))
+```
+
+**Fiber Example**
+```go
+app.Use(filesystem.New(filesystem.Config{
+	Root:         http.FS(subFS),
+	Browse:       false,
+	Index:        "index.html",
+	NotFoundFile: "404.html", // Change this
+}))
+```
+
+**Chi Example**
+```go
+mux.Handle("/*", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+	path := strings.TrimPrefix(r.URL.Path, "/")
+
+	// Check if the requested file exists
+	_, err := subFS.Open(path)
+	if err != nil {
+		// If not found, serve fallback page.
+		http.ServeFileFS(w, r, subFS, "404.html") // Change this
+		return
+	}
+
+    fs.ServeHTTP(w, r)
+}))
+```

template/api/api.go.chi.tmpl

@@ -1,3 +1,4 @@
+{{- if .Render.IsTemplates -}}
 package api
 
 import (
@@ -101,4 +102,61 @@ func (api *APIServer) registerGlobalMiddlewares(mux *chi.Mux) {
 	mux.Use(middleware.Recoverer)
 
 	api.ServeStatic(mux)
-}
+}
+{{- else if .Render.IsSeperate -}}
+package api
+
+import (
+	"log"
+	"net/http"
+
+	"{{ .ModPath }}/config"
+
+	"github.com/go-chi/chi/v5"
+	"github.com/go-chi/chi/v5/middleware"
+)
+
+type ServerConfig struct {
+	// Serving static assets from `web` folder.
+	ServeStatic func(*chi.Mux)
+}
+
+type APIServer struct {
+	listenAddr string
+	env        config.EnvConfig
+	ServerConfig
+}
+
+func NewAPIServer(env config.EnvConfig, cfg ServerConfig) *APIServer {
+	return &APIServer{
+		listenAddr:   ":" + env.PORT,
+		env:          env,
+		ServerConfig: cfg,
+	}
+}
+
+// Start will run the API Server
+// Any global middlewares like Logger should be registered here.
+func (api *APIServer) Start() error {
+	mux := chi.NewMux()
+
+	// Global Middlewares
+	api.registerGlobalMiddlewares(mux)
+
+	// Routes
+	r := NewRouter(api.env)
+	r.RegisterRoutes(mux)
+
+	log.Printf("Visit http://localhost%s", api.listenAddr)
+
+	return http.ListenAndServe(api.listenAddr, mux)
+}
+
+// Extend the list of global middlewares as needed.
+func (api *APIServer) registerGlobalMiddlewares(mux *chi.Mux) {
+	mux.Use(middleware.Logger) // Logger should come before Recoverer
+	mux.Use(middleware.Recoverer)
+
+	api.ServeStatic(mux)
+}
+{{- end -}}

template/api/api.go.echo.tmpl

@@ -1,3 +1,4 @@
+{{- if .Render.IsTemplates -}}
 package api
 
 import (
@@ -81,4 +82,64 @@ func (api *APIServer) registerGlobalMiddlewares(e *echo.Echo) {
 	e.Renderer = &Template{templates: api.LoadTemplates(e), env: api.env}
 
 	api.ServeStatic(e)
-}
+}
+{{- else if .Render.IsSeperate -}}
+package api
+
+import (
+	"log"
+
+	"{{ .ModPath }}/config"
+
+	"github.com/labstack/echo/v4"
+	"github.com/labstack/echo/v4/middleware"
+)
+
+type ServerConfig struct {
+	// Serving static assets from `web` folder.
+	ServeStatic func(*echo.Echo)
+}
+
+type APIServer struct {
+	listenAddr string
+	env        config.EnvConfig
+	ServerConfig
+}
+
+func NewAPIServer(env config.EnvConfig, cfg ServerConfig) *APIServer {
+	return &APIServer{
+		listenAddr:   ":" + env.PORT,
+		env:          env,
+		ServerConfig: cfg,
+	}
+}
+
+// Start will run the API Server
+// Any global middlewares like Logger should be registered here.
+func (api *APIServer) Start() error {
+	e := echo.New()
+
+	// Global Middlewares
+	api.registerGlobalMiddlewares(e)
+
+	// Routes
+	r := NewRouter(api.env)
+	r.RegisterRoutes(e.Router())
+
+	log.Printf("Visit http://localhost%s", api.listenAddr)
+
+	return e.Start(api.listenAddr)
+}
+
+// Extend the list of global middlewares as needed.
+func (api *APIServer) registerGlobalMiddlewares(e *echo.Echo) {
+	e.Use(middleware.Recover())
+	e.Use(middleware.LoggerWithConfig(middleware.LoggerConfig{
+		Format: "-> '${uri}' - ${method} (${status})\n",
+	}))
+
+	e.HTTPErrorHandler = HTTPErrorHandler
+
+	api.ServeStatic(e)
+}
+{{- end -}}