+ 
+ 
+
+
+
}
diff --git a/cmd/template/advanced/files/htmx/hello_fiber.go.tmpl b/cmd/template/frontend/files/htmx/hello_fiber.go.tmpl
similarity index 100%
rename from cmd/template/advanced/files/htmx/hello_fiber.go.tmpl
rename to cmd/template/frontend/files/htmx/hello_fiber.go.tmpl
diff --git a/cmd/template/advanced/files/htmx/htmx.min.js.tmpl b/cmd/template/frontend/files/htmx/htmx.min.js.tmpl
similarity index 100%
rename from cmd/template/advanced/files/htmx/htmx.min.js.tmpl
rename to cmd/template/frontend/files/htmx/htmx.min.js.tmpl
diff --git a/cmd/template/advanced/files/htmx/imports/fiber.tmpl b/cmd/template/frontend/files/htmx/imports/fiber.tmpl
similarity index 100%
rename from cmd/template/advanced/files/htmx/imports/fiber.tmpl
rename to cmd/template/frontend/files/htmx/imports/fiber.tmpl
diff --git a/cmd/template/advanced/files/htmx/imports/gin.tmpl b/cmd/template/frontend/files/htmx/imports/gin.tmpl
similarity index 100%
rename from cmd/template/advanced/files/htmx/imports/gin.tmpl
rename to cmd/template/frontend/files/htmx/imports/gin.tmpl
diff --git a/cmd/template/advanced/files/htmx/imports/standard_library.tmpl b/cmd/template/frontend/files/htmx/imports/standard_library.tmpl
similarity index 100%
rename from cmd/template/advanced/files/htmx/imports/standard_library.tmpl
rename to cmd/template/frontend/files/htmx/imports/standard_library.tmpl
diff --git a/cmd/template/advanced/files/htmx/routes/chi.tmpl b/cmd/template/frontend/files/htmx/routes/chi.tmpl
similarity index 100%
rename from cmd/template/advanced/files/htmx/routes/chi.tmpl
rename to cmd/template/frontend/files/htmx/routes/chi.tmpl
diff --git a/cmd/template/advanced/files/htmx/routes/echo.tmpl b/cmd/template/frontend/files/htmx/routes/echo.tmpl
similarity index 100%
rename from cmd/template/advanced/files/htmx/routes/echo.tmpl
rename to cmd/template/frontend/files/htmx/routes/echo.tmpl
diff --git a/cmd/template/advanced/files/htmx/routes/fiber.tmpl b/cmd/template/frontend/files/htmx/routes/fiber.tmpl
similarity index 100%
rename from cmd/template/advanced/files/htmx/routes/fiber.tmpl
rename to cmd/template/frontend/files/htmx/routes/fiber.tmpl
diff --git a/cmd/template/advanced/files/htmx/routes/gin.tmpl b/cmd/template/frontend/files/htmx/routes/gin.tmpl
similarity index 100%
rename from cmd/template/advanced/files/htmx/routes/gin.tmpl
rename to cmd/template/frontend/files/htmx/routes/gin.tmpl
diff --git a/cmd/template/advanced/files/htmx/routes/gorilla.tmpl b/cmd/template/frontend/files/htmx/routes/gorilla.tmpl
similarity index 100%
rename from cmd/template/advanced/files/htmx/routes/gorilla.tmpl
rename to cmd/template/frontend/files/htmx/routes/gorilla.tmpl
diff --git a/cmd/template/advanced/files/htmx/routes/http_router.tmpl b/cmd/template/frontend/files/htmx/routes/http_router.tmpl
similarity index 100%
rename from cmd/template/advanced/files/htmx/routes/http_router.tmpl
rename to cmd/template/frontend/files/htmx/routes/http_router.tmpl
diff --git a/cmd/template/advanced/files/htmx/routes/standard_library.tmpl b/cmd/template/frontend/files/htmx/routes/standard_library.tmpl
similarity index 100%
rename from cmd/template/advanced/files/htmx/routes/standard_library.tmpl
rename to cmd/template/frontend/files/htmx/routes/standard_library.tmpl
diff --git a/cmd/template/advanced/files/react/app.tsx.tmpl b/cmd/template/frontend/files/react/app.tsx.tmpl
similarity index 100%
rename from cmd/template/advanced/files/react/app.tsx.tmpl
rename to cmd/template/frontend/files/react/app.tsx.tmpl
diff --git a/cmd/template/advanced/files/react/tailwind/app.tsx.tmpl b/cmd/template/frontend/files/react/tailwind/app.tsx.tmpl
similarity index 100%
rename from cmd/template/advanced/files/react/tailwind/app.tsx.tmpl
rename to cmd/template/frontend/files/react/tailwind/app.tsx.tmpl
diff --git a/cmd/template/advanced/files/react/tailwind/index.css.tmpl b/cmd/template/frontend/files/react/tailwind/index.css.tmpl
similarity index 100%
rename from cmd/template/advanced/files/react/tailwind/index.css.tmpl
rename to cmd/template/frontend/files/react/tailwind/index.css.tmpl
diff --git a/cmd/template/advanced/files/react/tailwind/tailwind.config.js.tmpl b/cmd/template/frontend/files/react/tailwind/tailwind.config.js.tmpl
similarity index 100%
rename from cmd/template/advanced/files/react/tailwind/tailwind.config.js.tmpl
rename to cmd/template/frontend/files/react/tailwind/tailwind.config.js.tmpl
diff --git a/cmd/template/advanced/files/tailwind/input.css.tmpl b/cmd/template/frontend/files/tailwind/input.css.tmpl
similarity index 100%
rename from cmd/template/advanced/files/tailwind/input.css.tmpl
rename to cmd/template/frontend/files/tailwind/input.css.tmpl
diff --git a/cmd/template/advanced/files/tailwind/output.css.tmpl b/cmd/template/frontend/files/tailwind/output.css.tmpl
similarity index 100%
rename from cmd/template/advanced/files/tailwind/output.css.tmpl
rename to cmd/template/frontend/files/tailwind/output.css.tmpl
diff --git a/cmd/template/advanced/files/tailwind/tailwind.config.js.tmpl b/cmd/template/frontend/files/tailwind/tailwind.config.js.tmpl
similarity index 100%
rename from cmd/template/advanced/files/tailwind/tailwind.config.js.tmpl
rename to cmd/template/frontend/files/tailwind/tailwind.config.js.tmpl
diff --git a/cmd/template/frontend/routes.go b/cmd/template/frontend/routes.go
new file mode 100644
index 00000000..8a221301
--- /dev/null
+++ b/cmd/template/frontend/routes.go
@@ -0,0 +1,166 @@
+package frontend
+
+import (
+ _ "embed"
+)
+
+//go:embed files/htmx/hello.templ.tmpl
+var helloTemplTemplate []byte
+
+//go:embed files/htmx/base.templ.tmpl
+var baseTemplTemplate []byte
+
+//go:embed files/tailwind/tailwind.config.js.tmpl
+var tailwindConfigTemplate []byte
+
+//go:embed files/react/tailwind/tailwind.config.js.tmpl
+var reactTailwindConfigTemplate []byte
+
+//go:embed files/react/tailwind/index.css.tmpl
+var inputCssTemplateReact []byte
+
+//go:embed files/react/tailwind/app.tsx.tmpl
+var reactTailwindAppFile []byte
+
+//go:embed files/react/app.tsx.tmpl
+var reactAppFile []byte
+
+//go:embed files/tailwind/input.css.tmpl
+var inputCssTemplate []byte
+
+//go:embed files/tailwind/output.css.tmpl
+var outputCssTemplate []byte
+
+//go:embed files/htmx/htmx.min.js.tmpl
+var htmxMinJsTemplate []byte
+
+//go:embed files/htmx/efs.go.tmpl
+var efsTemplate []byte
+
+//go:embed files/htmx/hello.go.tmpl
+var helloGoTemplate []byte
+
+//go:embed files/htmx/hello_fiber.go.tmpl
+var helloFiberGoTemplate []byte
+
+//go:embed files/htmx/routes/http_router.tmpl
+var httpRouterHtmxTemplRoutes []byte
+
+//go:embed files/htmx/routes/standard_library.tmpl
+var stdLibHtmxTemplRoutes []byte
+
+//go:embed files/htmx/imports/standard_library.tmpl
+var stdLibHtmxTemplImports []byte
+
+//go:embed files/htmx/routes/chi.tmpl
+var chiHtmxTemplRoutes []byte
+
+//go:embed files/htmx/routes/gin.tmpl
+var ginHtmxTemplRoutes []byte
+
+//go:embed files/htmx/imports/gin.tmpl
+var ginHtmxTemplImports []byte
+
+//go:embed files/htmx/routes/gorilla.tmpl
+var gorillaHtmxTemplRoutes []byte
+
+//go:embed files/htmx/routes/echo.tmpl
+var echoHtmxTemplRoutes []byte
+
+//go:embed files/htmx/routes/fiber.tmpl
+var fiberHtmxTemplRoutes []byte
+
+//go:embed files/htmx/imports/fiber.tmpl
+var fiberHtmxTemplImports []byte
+
+func EchoHtmxTemplRoutesTemplate() []byte {
+ return echoHtmxTemplRoutes
+}
+
+func GorillaHtmxTemplRoutesTemplate() []byte {
+ return gorillaHtmxTemplRoutes
+}
+
+func ChiHtmxTemplRoutesTemplate() []byte {
+ return chiHtmxTemplRoutes
+}
+
+func GinHtmxTemplRoutesTemplate() []byte {
+ return ginHtmxTemplRoutes
+}
+
+func HttpRouterHtmxTemplRoutesTemplate() []byte {
+ return httpRouterHtmxTemplRoutes
+}
+
+func StdLibHtmxTemplRoutesTemplate() []byte {
+ return stdLibHtmxTemplRoutes
+}
+
+func StdLibHtmxTemplImportsTemplate() []byte {
+ return stdLibHtmxTemplImports
+}
+
+func HelloTemplTemplate() []byte {
+ return helloTemplTemplate
+}
+
+func BaseTemplTemplate() []byte {
+ return baseTemplTemplate
+}
+
+func TailwindConfigTemplate() []byte {
+ return tailwindConfigTemplate
+}
+
+func ReactTailwindConfigTemplate() []byte {
+ return reactTailwindConfigTemplate
+}
+
+func ReactTailwindAppfile() []byte {
+ return reactTailwindAppFile
+}
+
+func ReactAppfile() []byte {
+ return reactAppFile
+}
+
+func InputCssTemplateReact() []byte {
+ return inputCssTemplateReact
+}
+
+func InputCssTemplate() []byte {
+ return inputCssTemplate
+}
+
+func OutputCssTemplate() []byte {
+ return outputCssTemplate
+}
+
+func HtmxJSTemplate() []byte {
+ return htmxMinJsTemplate
+}
+
+func EfsTemplate() []byte {
+ return efsTemplate
+}
+
+func HelloGoTemplate() []byte {
+ return helloGoTemplate
+}
+
+func HelloFiberGoTemplate() []byte {
+ return helloFiberGoTemplate
+}
+
+func FiberHtmxTemplRoutesTemplate() []byte {
+ return fiberHtmxTemplRoutes
+}
+
+func FiberHtmxTemplImportsTemplate() []byte {
+ return fiberHtmxTemplImports
+}
+
+func GinHtmxTemplImportsTemplate() []byte {
+ return ginHtmxTemplImports
+}
diff --git a/cmd/template/globalEnv.go b/cmd/template/globalEnv.go
index 9645fb69..b44c2ecc 100644
--- a/cmd/template/globalEnv.go
+++ b/cmd/template/globalEnv.go
@@ -4,7 +4,7 @@ import (
_ "embed"
)
-//go:embed framework/files/globalenv.tmpl
+//go:embed backend/files/globalenv.tmpl
var globalEnvTemplate []byte
func GlobalEnvTemplate() []byte {
diff --git a/cmd/utils/utils.go b/cmd/utils/utils.go
index 7ba4dd34..ad09cdf1 100644
--- a/cmd/utils/utils.go
+++ b/cmd/utils/utils.go
@@ -19,30 +19,79 @@ const ProgramName = "go-blueprint"
func NonInteractiveCommand(use string, flagSet *pflag.FlagSet) string {
nonInteractiveCommand := fmt.Sprintf("%s %s", ProgramName, use)
- visitFn := func(flag *pflag.Flag) {
- if flag.Name != "help" {
- if flag.Name == "feature" {
- featureFlagsString := ""
- // Creates string representation for the feature flags to be
- // concatenated with the nonInteractiveCommand
- for _, k := range strings.Split(flag.Value.String(), ",") {
- if k != "" {
- featureFlagsString += fmt.Sprintf(" --feature %s", k)
- }
- }
- nonInteractiveCommand += featureFlagsString
- } else if flag.Value.Type() == "bool" {
+ // Helper function to get flag prefix (-n or --name)
+ getFlagPrefix := func(flag *pflag.Flag) string {
+ if flag.Shorthand != "" {
+ return fmt.Sprintf("-%s", flag.Shorthand)
+ }
+ return fmt.Sprintf("--%s", flag.Name)
+ }
+
+ // name flag
+ flagSet.VisitAll(func(flag *pflag.Flag) {
+ if flag.Name == "name" && flag.Value.String() != "" {
+ nonInteractiveCommand = fmt.Sprintf("%s %s %s", nonInteractiveCommand,
+ getFlagPrefix(flag), flag.Value.String())
+ }
+ })
+
+ // main flags (excluding name, git, feature, frontend-advanced, and advanced)
+ flagSet.VisitAll(func(flag *pflag.Flag) {
+ if flag.Name != "help" && flag.Name != "feature" &&
+ flag.Name != "frontend-advanced" && flag.Name != "git" &&
+ flag.Name != "name" && flag.Name != "advanced" {
+ if flag.Value.Type() == "bool" {
if flag.Value.String() == "true" {
- nonInteractiveCommand = fmt.Sprintf("%s --%s", nonInteractiveCommand, flag.Name)
+ nonInteractiveCommand = fmt.Sprintf("%s %s", nonInteractiveCommand,
+ getFlagPrefix(flag))
}
} else {
- nonInteractiveCommand = fmt.Sprintf("%s --%s %s", nonInteractiveCommand, flag.Name, flag.Value.String())
+ if flag.Value.String() != "" {
+ nonInteractiveCommand = fmt.Sprintf("%s %s %s", nonInteractiveCommand,
+ getFlagPrefix(flag), flag.Value.String())
+ }
}
}
+ })
+
+ // frontend-advanced flags
+ flagSet.VisitAll(func(flag *pflag.Flag) {
+ if flag.Name == "frontend-advanced" && flag.Value.String() != "" {
+ nonInteractiveCommand = fmt.Sprintf("%s %s %s", nonInteractiveCommand,
+ getFlagPrefix(flag), flag.Value.String())
+ }
+ })
+
+ // advanced flag and features together
+ var hasAdvanced bool
+ flagSet.VisitAll(func(flag *pflag.Flag) {
+ if flag.Name == "advanced" && flag.Value.String() == "true" {
+ hasAdvanced = true
+ nonInteractiveCommand = fmt.Sprintf("%s %s", nonInteractiveCommand,
+ getFlagPrefix(flag))
+ }
+ })
+
+ if hasAdvanced {
+ flagSet.VisitAll(func(flag *pflag.Flag) {
+ if flag.Name == "feature" {
+ featureFlags := strings.Split(flag.Value.String(), ",")
+ for _, k := range featureFlags {
+ if k != "" {
+ nonInteractiveCommand = fmt.Sprintf("%s --feature %s", nonInteractiveCommand, k)
+ }
+ }
+ }
+ })
}
- flagSet.SortFlags = false
- flagSet.VisitAll(visitFn)
+ // git flag
+ flagSet.VisitAll(func(flag *pflag.Flag) {
+ if flag.Name == "git" && flag.Value.String() != "" {
+ nonInteractiveCommand = fmt.Sprintf("%s %s %s", nonInteractiveCommand,
+ getFlagPrefix(flag), flag.Value.String())
+ }
+ })
return nonInteractiveCommand
}
diff --git a/contributors.yml b/contributors.yml
index 74c13442..aa5407a0 100644
--- a/contributors.yml
+++ b/contributors.yml
@@ -17,7 +17,9 @@
- briancbarrow
- arafays
- LrsK
+- alexandear
- juleszs
+- Sakelig
- vadhe
- Patel-Raj
- PrajvalBadiger
@@ -25,12 +27,10 @@
- pellizzetti
- Owbird
- Jamlie
-- alexandear
- NimishKashyap
- narasaka
- mubashiroliyantakath
- abhishekmj303
-- Sakelig
- reavessm
- young-steveo
- sibteali786
@@ -39,6 +39,7 @@
- vsnaichuk
- Waldeedle
- jpx40
+- leakedmemory
- nhlmg93
- rustafariandev
- s0up4200
diff --git a/docs/docs/advanced-flag/advanced-flag.md b/docs/docs/advanced-flag/advanced-flag.md
index 124ef6b9..0ecefedb 100644
--- a/docs/docs/advanced-flag/advanced-flag.md
+++ b/docs/docs/advanced-flag/advanced-flag.md
@@ -1,9 +1,6 @@
# Advanced Flag in Blueprint
-The `--advanced` flag in Blueprint serves as a switch to enable additional features during project creation. It is applied with the `create` command and unlocks the following features:
-
-- **HTMX Support using Templ:**
-Enables the integration of HTMX support for dynamic web pages using Templ.
+The `--advanced` or `-a` flag in Blueprint serves as a switch to enable additional features during project creation. It is applied with the `create` command and unlocks the following features:
- **CI/CD Workflow Setup using GitHub Actions:**
Automates the setup of a CI/CD workflow using GitHub Actions.
@@ -11,31 +8,19 @@ Automates the setup of a CI/CD workflow using GitHub Actions.
- **Websocket Support:**
WebSocket endpoint that sends continuous data streams through the WS protocol.
-- **Tailwind:**
-Adds Tailwind CSS support to the project.
-
- **Docker:**
Docker configuration for go project.
-- **React:**
-Frontend written in TypeScript, including an example fetch request to the backend.
-
-
To utilize the `--advanced` flag, use the following command:
```bash
-go-blueprint create --name --framework --driver --advanced
+go-blueprint create -n -b -driver -a
```
-By including the `--advanced` flag, users can choose one or all of the advanced features. The flag enhances the simplicity of Blueprint while offering flexibility for users who require additional functionality.
-
-To recreate the project using the same configuration semi-interactively, use the following command:
-```bash
-go-blueprint create --name my-project --framework chi --driver mysql --advanced
-```
+By including the `--advanced` flag, users can choose one or all of the advanced features. The flag enhances the simplicity of Blueprint while offering flexibility for users who require additional functionality.
Non-Interactive Setup is also possible:
```bash
-go-blueprint create --name my-project --framework chi --driver mysql --advanced --feature htmx --feature githubaction --feature websocket --feature tailwind
+go-blueprint create -n my_project -b standard-library -d redis -a --feature docker --feature githubaction --feature websocket -g commit
```
diff --git a/docs/docs/advanced-flag/goreleaser.md b/docs/docs/advanced-flag/goreleaser.md
index 43f1f2c5..b1c1dcb3 100644
--- a/docs/docs/advanced-flag/goreleaser.md
+++ b/docs/docs/advanced-flag/goreleaser.md
@@ -32,7 +32,7 @@ The job outlined in this workflow includes the following steps:
Fetches the project's codebase from the repository.
2. **Go Setup:**
- Configures the Go environment with version 1.21.x.
+ Configures the Go environment with version 1.23.x.
3. **Build and Test:**
Builds the project using `go build` and runs tests across all packages (`./...`) using `go test`.
diff --git a/docs/docs/advanced-flag/websocket.md b/docs/docs/advanced-flag/websocket.md
index c7bea3ad..64e36a10 100644
--- a/docs/docs/advanced-flag/websocket.md
+++ b/docs/docs/advanced-flag/websocket.md
@@ -1,4 +1,4 @@
-A `/websocket` endpoint is added in `routes.go` to facilitate websocket connections. Upon accessing this endpoint, the server establishes a websocket connection and begins transmitting timestamp messages at 2-second intervals. WS is utilized across all Go-blueprint supported frameworks. This simple implementation showcases how flexible project is.
+A `/websocket` endpoint is added in `routes.go` to facilitate websocket connections. Upon accessing this endpoint, the server establishes a websocket connection and begins transmitting timestamp messages at 2-second intervals. WS is utilized across all Go-blueprint supported backends. This simple implementation showcases how flexible project is.
### Code Implementation
diff --git a/docs/docs/blueprint-core/frameworks.md b/docs/docs/blueprint-core/backend-frameworks.md
similarity index 59%
rename from docs/docs/blueprint-core/frameworks.md
rename to docs/docs/blueprint-core/backend-frameworks.md
index 00aa84df..48aa6018 100644
--- a/docs/docs/blueprint-core/frameworks.md
+++ b/docs/docs/blueprint-core/backend-frameworks.md
@@ -1,11 +1,11 @@
-Created project can utilizes several Go web frameworks to handle HTTP routing and server functionality. The chosen frameworks are:
+Created project can utilizes several Go web backends to handle HTTP routing and server functionality. The chosen backends are:
-1. [**Chi**](https://github.com/go-chi/chi): Lightweight and flexible router for building Go HTTP services.
-2. [**Echo**](https://github.com/labstack/echo): High-performance, extensible, minimalist Go web framework.
-3. [**Fiber**](https://github.com/gofiber/fiber): Express-inspired web framework designed to be fast, simple, and efficient.
-4. [**Gin**](https://github.com/gin-gonic/gin): A web framework with a martini-like API, but with much better performance.
+1. [**Standard-library**](https://pkg.go.dev/std): Offers a vast collection of packages and functions.
+2. [**Chi**](https://github.com/go-chi/chi): Lightweight and flexible router for building Go HTTP services.
+3. [**Gin**](https://github.com/gin-gonic/gin): A web framework with a martini-like API, but with much better performance.
+4. [**Fiber**](https://github.com/gofiber/fiber): Express-inspired web framework designed to be fast, simple, and efficient.
5. [**Gorilla/mux**](https://github.com/gorilla/mux): A powerful URL router and dispatcher for Golang.
-6. [**HttpRouter**](https://github.com/julienschmidt/httprouter): A high-performance HTTP request router that scales well.
+6. [**Echo**](https://github.com/labstack/echo): High-performance, extensible, minimalist Go web framework.
## Project Structure
diff --git a/docs/docs/blueprint-core/db-drivers.md b/docs/docs/blueprint-core/db-drivers.md
index f34c72d0..eded11fa 100644
--- a/docs/docs/blueprint-core/db-drivers.md
+++ b/docs/docs/blueprint-core/db-drivers.md
@@ -1,10 +1,10 @@
To extend the project with database functionality, users can choose from a variety of Go database drivers. Each driver is tailored to work with specific database systems, providing flexibility based on project requirements:
-1. [Mongo](https://go.mongodb.org/mongo-driver): Provides necessary tools for connecting and interacting with MongoDB databases.
-2. [Mysql](https://github.com/go-sql-driver/mysql): Enables seamless integration with MySQL databases.
-3. [Postgres](https://github.com/jackc/pgx/): Facilitates connectivity to PostgreSQL databases.
-4. [Redis](https://github.com/redis/go-redis): Provides tools for connecting and interacting with Redis.
-5. [Sqlite](https://github.com/mattn/go-sqlite3): Suitable for projects requiring a lightweight, self-contained database. and interacting with Redis
+1. [Mysql](https://github.com/go-sql-driver/mysql): Enables seamless integration with MySQL databases.
+2. [Postgres](https://github.com/jackc/pgx/): Facilitates connectivity to PostgreSQL databases.
+3. [Sqlite](https://github.com/mattn/go-sqlite3): Suitable for projects requiring a lightweight, self-contained database.
+4. [Mongo](https://go.mongodb.org/mongo-driver): Provides necessary tools for connecting and interacting with MongoDB databases.
+5. [Redis](https://github.com/redis/go-redis): Provides tools for connecting and interacting with Redis.
6. [ScyllaDB](https://github.com/scylladb/gocql): Facilitates connectivity to ScyllaDB databases.
## Updated Project Structure
diff --git a/docs/docs/blueprint-ui.md b/docs/docs/blueprint-ui.md
deleted file mode 100644
index a7f9e203..00000000
--- a/docs/docs/blueprint-ui.md
+++ /dev/null
@@ -1,7 +0,0 @@
-The Blueprint UI is a crucial component of the Go Blueprint ecosystem, providing a user-friendly interface for creating CLI commands and visualizing project structures.
-
-By visiting the Blueprint UI website at [go-blueprint.dev](https://go-blueprint.dev), users can interact with a visual representation of their project setup before executing commands.
-
-
-
-This enhances the overall experience of using Go Blueprint by providing a visual representation of project setups and simplifying the command generation process. Check Blueprint UI [code](https://github.com/briancbarrow/go-blueprint-htmx).
diff --git a/docs/docs/creating-project/project-init.md b/docs/docs/creating-project/project-init.md
index 9eae177c..044a3977 100644
--- a/docs/docs/creating-project/project-init.md
+++ b/docs/docs/creating-project/project-init.md
@@ -6,7 +6,7 @@ After installing the Go-Blueprint CLI tool, you can create a new project with th
go-blueprint create
```
-This command will interactively guide you through the project setup process, allowing you to choose the project name, framework, and database driver.
+This command will interactively guide you through the project setup process, allowing you to choose the project name, backend, and database driver.
@@ -15,62 +15,48 @@ This command will interactively guide you through the project setup process, all
For a non-interactive setup, you can use flags to provide the necessary information during project creation. Here's an example:
```
-go-blueprint create --name my-project --framework gin --driver postgres --git commit
+go-blueprint create -n my-project -b chi -d postgres -g commit
```
In this example:
-- `--name`: Specifies the name of the project (replace "my-project" with your desired project name).
-- `--framework`: Specifies the Go framework to be used (e.g., "gin").
-- `--driver`: Specifies the database driver to be integrated (e.g., "postgres").
-- `--git`: Specifies the git configuration option of the project (e.g., "commit").
+- `-n` or `--name`: Specifies the name of the project (replace "my-project" with your desired project name).
+- `-b` or `--backend-framework`: Specifies the Go backend to be used (e.g., "gin").
+- `-d` or `--driver`: Specifies the database driver to be integrated (e.g., "postgres").
+- `-g` or `--git`: Specifies the git configuration option of the project (e.g., "commit").
Customize the flags according to your project requirements.
-## Advanced Flag
+## Frontend Frameworks and Features
-By including the `--advanced` flag, users can choose one or all of the advanced features, HTMX, GitHub Actions for CI/CD, Websocket, Docker and TailwindCSS support, during the project creation process. The flag enhances the simplicity of Blueprint while offering flexibility for users who require additional functionality.
+To include frontend frameworks and features in your project, you can use the `-f` flag to trigger the prompt:
```bash
-go-blueprint create --advanced
+go-blueprint create -f
```
-To recreate the project using the same configuration semi-interactively, use the following command:
+
+
+## Advanced Flag
+
+By including the `-a` or `--advanced` flag, users can choose one or all of the advanced features, GitHub Actions for CI/CD, Websocket and Docker, during the project creation process. The flag enhances the simplicity of Blueprint while offering flexibility for users who require additional functionality.
+
```bash
-go-blueprint create --name my-project --framework chi --driver mysql --git commit --advanced
+go-blueprint create -a
```
-This approach opens interactive mode only for advanced features, which allow you to choose the one or combination of available features.
-## Non-Interactive Setup
-
-Advanced features can be enabled using the `--feature` flag along with the `--advanced` flag:
+## Combining Flags
-HTMX:
-```bash
-go-blueprint create --advanced --feature htmx
-```
+Frontend and Advanced features can be combined with the `-f` and `-a` flags
-CI/CD workflow:
```bash
-go-blueprint create --advanced --feature githubaction
+go-blueprint create -af
```
-Websocket:
-```bash
-go-blueprint create --advanced --feature websocket
-```
-TailwindCSS:
-```bash
-go-blueprint create --advanced --feature tailwind
-```
-Docker:
-```bash
-go-blueprint create --advanced --feature docker
-```
+or
-Or all features at once:
```bash
-go-blueprint create --name my-project --framework chi --driver mysql --git commit --advanced --feature htmx --feature githubaction --feature websocket --feature tailwind --feature docker
+go-blueprint create -n my_project -b fiber -d mysql -f --frontend-framework htmx --frontend-advanced tailwind -a --feature docker --feature githubaction -g commit
```
diff --git a/docs/docs/endpoints-test/redis.md b/docs/docs/endpoints-test/redis.md
index ee375da7..c9af846b 100644
--- a/docs/docs/endpoints-test/redis.md
+++ b/docs/docs/endpoints-test/redis.md
@@ -113,56 +113,6 @@ The `Sample Output` is dynamic and unstructured since it depends on the raw map.
}
```
-- `XML serialization/deserialization`
-
-```xml
-
-
- up
- Redis connection pool utilization is high
-
- 7.0.15
- standalone
- 10
-
-
- 22.38
- 0.02
-
-
- 46.57
- 0.05
-
-
- 1130.00
- 1.10
-
- 1.98%
-
- 6 days, 3 hours, 37 minutes, 20 seconds
-
- 6
- 3
- 37
- 20
-
-
-
- 10
- 2
- 0
- 4
- 9
- 5
- 0
- 62.50%
-
- 26
-
-
-
-```
-
## Code Implementation
```go
diff --git a/docs/docs/endpoints-test/server.md b/docs/docs/endpoints-test/server.md
index ff788f2e..f0ad4b38 100644
--- a/docs/docs/endpoints-test/server.md
+++ b/docs/docs/endpoints-test/server.md
@@ -23,7 +23,7 @@ Sample Output:
{"message": "Hello World"}
```
If the server is running and it is healthy, you should see the message 'Hello World' in the response.
-Also, depending on the framework you are using, there will be logs in the terminal:
+Also, depending on the backend you are using, there will be logs in the terminal:
```bash
make run
diff --git a/docs/docs/advanced-flag/htmx-templ.md b/docs/docs/frontend/htmx-templ.md
similarity index 100%
rename from docs/docs/advanced-flag/htmx-templ.md
rename to docs/docs/frontend/htmx-templ.md
diff --git a/docs/docs/advanced-flag/react-vite.md b/docs/docs/frontend/react-vite.md
similarity index 90%
rename from docs/docs/advanced-flag/react-vite.md
rename to docs/docs/frontend/react-vite.md
index 01de8afe..1a2eb5f5 100644
--- a/docs/docs/advanced-flag/react-vite.md
+++ b/docs/docs/frontend/react-vite.md
@@ -1,6 +1,6 @@
This template provides a minimal setup for getting React working with Vite for the frontend and go on the backend. It allows you to easily integrate React with Tailwind CSS and Vite for fast development.
-The React advanced flag can be combined with the Tailwind flag for enhanced styling capabilities.
+The React fronted flag can be combined with the Tailwind flag for enhanced styling capabilities.
## Project Structure
@@ -66,10 +66,21 @@ You can extend the `vite.config.ts` to include additional configurations as need
The make run target will start the Go server in the backend, install frontend dependencies, and run the Vite development server for the frontend.
```bash
-run:
- @go run cmd/api/main.go &
- @npm install --prefix ./frontend
- @npm run dev --prefix ./frontend
+run: build
+ @echo "Starting server..."
+ @./main & \
+ SERVER_PID=$$!; \
+ sleep 2; \
+ if ps -p $$SERVER_PID > /dev/null; then \
+ echo "Server started successfully"; \
+ cd frontend && \
+ npm install --prefer-offline --no-fund && \
+ npm run dev; \
+ kill $$SERVER_PID; \
+ else \
+ echo "Server failed to start. Check the logs."; \
+ exit 1; \
+ fi
```
After running this command, you can verify the connection between the frontend and backend by checking the console. You can also fetch data from the backend to test the integration.
@@ -78,7 +89,7 @@ After running this command, you can verify the connection between the frontend a
## Dockerfile
-Combine React advanced flag with Docker flag to get Docker and docker-compose configuration and run them with:
+Combine React flag with advanced Docker flag to get Docker and docker-compose configuration and run them with:
```bash
make docker-run
@@ -217,7 +228,7 @@ The `VITE_PORT` in .env refers `PORT` from .env in project root ( for backend ).
## Notes
-- First time running the project creation with Tailwind can take longer (~10 mins) as npm needs to download and cache all packages
+- The first time running project creation with Tailwind may take longer as npm needs to download and cache all packages.
- Subsequent runs will be faster as they utilize npm's cache, which we enforce during project creation.
diff --git a/docs/docs/advanced-flag/tailwind.md b/docs/docs/frontend/tailwind.md
similarity index 89%
rename from docs/docs/advanced-flag/tailwind.md
rename to docs/docs/frontend/tailwind.md
index 0d2e4b66..a8fc318a 100644
--- a/docs/docs/advanced-flag/tailwind.md
+++ b/docs/docs/frontend/tailwind.md
@@ -1,6 +1,6 @@
-Tailwind is closely coupled with the advanced HTMX flag, and HTMX will be automatically used if you select Tailwind in your project.
+Tailwind is closely coupled with the fronted HTMX and React flags.
-We do not introduce outside dependencies automatically, and you need compile output.css (file is empty by default) with the Tailwind CLI tool.
+For HTMX we do not introduce outside dependencies automatically, and you need compile output.css (file is empty by default) with the Tailwind CLI tool.
The project tree would look like this:
```bash
diff --git a/docs/docs/index.md b/docs/docs/index.md
index 39e0fd00..d9585c57 100644
--- a/docs/docs/index.md
+++ b/docs/docs/index.md
@@ -7,7 +7,7 @@ hide:
-Powerful CLI tool designed to streamline the process of creating Go projects with a robust and standardized structure. Not only does Go Blueprint facilitate project initialization, but it also offers seamless integration with popular Go frameworks, allowing you to focus on your application's code from the very beginning.
+Powerful CLI tool designed to streamline the process of creating Go projects with a robust and standardized structure. Not only does Go Blueprint facilitate project initialization, but it also offers seamless integration with popular Go backends, frontend frameworks, allowing you to focus on your application's code from the very beginning.
## Why Choose Go Blueprint?
@@ -15,81 +15,31 @@ Powerful CLI tool designed to streamline the process of creating Go projects wit
- **Pre-established Go Project Structure**: Save time and effort by having the entire Go project structure set up automatically. No need to worry about directory layouts or configuration files.
-- **HTTP Server Configuration Made Easy**: Whether you prefer Go's standard library HTTP package, Chi, Gin, Fiber, HttpRouter, Gorilla/mux or Echo, Go Blueprint caters to your server setup needs.
+- **HTTP Server Configuration Made Easy**: Whether you prefer Go's standard library HTTP package, Chi, Gin, Fiber, Gorilla/mux or Echo, Go Blueprint caters to your server setup needs.
- **Focus on Your Application Code**: With Go Blueprint handling the project scaffolding, you can dedicate more time and energy to developing your application logic.
## Project Structure
-Here's an overview of the project structure created by Go Blueprint when all options are utilized:
+By visiting the Blueprint UI website at [go-blueprint.dev](https://go.blueprint.dev), you can interact with a visual representation of the project setup before executing commands. It provides a user-friendly interface for creating CLI commands and visualizing project structures.
-```bash
-/ (Root)
-├── .github/
-│ └── workflows/
-│ ├── go-test.yml # GitHub Actions workflow for running tests.
-│ └── release.yml # GitHub Actions workflow for releasing the application.
-├── cmd/
-│ ├── api/
-│ │ └── main.go # Main file for starting the server.
-│ └── web/
-│ ├── styles/ # only for generating css will not be served public
-│ │ └── input.css # Tailwind input file for compiling output.css with CLI when HTMX is used
-│ ├── assets/
-│ │ ├── css/
-│ │ │ └── output.css # Generated CSS file.
-│ │ └── js/
-│ │ └── htmx.min.js # HTMX library for dynamic HTML content.
-│ ├── base.templ # Base HTML template file.
-│ ├── base_templ.go # Generated Go code for base template.
-│ ├── efs.go # Includes assets into compiled binary.
-│ ├── hello.go # Logic for handling "hello" form.
-│ ├── hello.templ # Template file for the "hello" endpoint.
-│ └── hello_templ.go # Generated Go code for the "hello" template.
-├── frontend/ # React advanced flag. Excludes HTMX.
-│ ├── node_modules/ # Node dependencies.
-│ ├── public/
-│ │ ├── index.html
-│ │ └── favicon.ico
-│ ├── src/ # React source files.
-│ │ ├── App.tsx # Main React component.
-│ │ ├── assets/ # React assets directory
-│ │ │ └── logo.svg
-│ │ ├── components/ # React components directory.
-│ │ │ ├── Header.tsx
-│ │ │ └── Footer.tsx
-│ │ ├── styles/ # CSS/SCSS styles directory.
-│ │ │ └── global.css
-│ │ └── index.tsx # Main entry point for React
-│ ├── eslint.config.js # ESLint configuration file.
-│ ├── index.html # Base HTML template.
-│ ├── package.json # Node.js package configuration.
-│ ├── package-lock.json # Lock file for Node.js dependencies.
-│ ├── README.md # README file for the React project.
-│ ├── tsconfig.app.json # TypeScript configuration for the app.
-│ ├── tsconfig.json # Root TypeScript configuration.
-│ ├── tsconfig.node.json # TypeScript configuration for Node.js.
-│ └── vite.config.ts # Vite configuration file.
-├── internal/
-│ ├── database/
-│ │ ├── database_test.go # File containing integration tests for the database operations.
-│ │ └── database.go # File containing functions related to database operations.
-│ └── server/
-│ ├── routes.go # File defining HTTP routes.
-│ ├── routes_test.go # Test file for testing HTTP handlers.
-│ └── server.go # Main server logic.
-├── .air.toml # Configuration file for Air, a live-reload utility.
-├── docker-compose.yml # Docker Compose configuration.
-├── Dockerfile # Dockerfile configuration for the Go project.
-├── .env # Environment configuration file.
-├── .gitignore # File specifying which files and directories to ignore in Git.
-├── go.mod # Go module file for managing dependencies.
-├── .goreleaser.yml # Configuration file for GoReleaser, a tool for building and releasing binaries.
-├── go.sum # Go module file containing checksums for dependencies.
-├── Makefile # Makefile for defining and running commands.
-├── tailwind.config.js # Tailwind CSS configuration file for HTMX.
-└── README.md # Project's README file containing essential information about the project.
+
-```
+Execute go-blueprint create -h to see all the options and shorthands
-This structure provides a comprehensive organization of your project, separating source code, tests, configurations and documentation.
+```bash
+Usage:
+ go-blueprint create [flags]
+
+Flags:
+ -a, --advanced Get prompts for advanced features
+ --feature AdvancedFeatures Advanced feature to use. Allowed values: githubaction, websocket, docker
+ -b, --backend-framework BackendFramework Backend framework to use. Allowed values: chi, gin, fiber, gorilla/mux, standard-library, echo
+ -d, --driver Database Database drivers to use. Allowed values: mysql, postgres, sqlite, mongo, redis, scylla, none
+ -f, --frontend Get prompts for frontend frameworks
+ --frontend-framework Frontendframework Frontend framework to use. Allowed values: htmx, react
+ --frontend-advanced FrontendAdvanced Frontend framework advanced features to use. Allowed values: tailwind
+ -g, --git Git Git to use. Allowed values: commit, stage, skip
+ -h, --help help for create
+ -n, --name string Name of project to create
+```
diff --git a/docs/docs/public/blueprint_1.png b/docs/docs/public/blueprint_1.png
index 093ababd..85370ffa 100644
Binary files a/docs/docs/public/blueprint_1.png and b/docs/docs/public/blueprint_1.png differ
diff --git a/docs/docs/public/blueprint_advanced.png b/docs/docs/public/blueprint_advanced.png
index 5177e0be..0865fd7d 100644
Binary files a/docs/docs/public/blueprint_advanced.png and b/docs/docs/public/blueprint_advanced.png differ
diff --git a/docs/docs/public/blueprint_frontend.png b/docs/docs/public/blueprint_frontend.png
new file mode 100644
index 00000000..4a14a8cf
Binary files /dev/null and b/docs/docs/public/blueprint_frontend.png differ
diff --git a/docs/docs/public/blueprint_ui.png b/docs/docs/public/blueprint_ui.png
index e7bbfa4a..32284f5a 100644
Binary files a/docs/docs/public/blueprint_ui.png and b/docs/docs/public/blueprint_ui.png differ
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index b9ece5be..97370b46 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -31,22 +31,22 @@ theme:
nav:
- Home: index.md
- Installation: installation.md
- - Blueprint UI: blueprint-ui.md
- Project creation & default config:
- Project init: creating-project/project-init.md
- Makefile: creating-project/makefile.md
- Air: creating-project/air.md
- Blueprint Core:
- - Frameworks: blueprint-core/frameworks.md
+ - Backend Frameworks: blueprint-core/backend-frameworks.md
- DB Drivers: blueprint-core/db-drivers.md
+ - Frontend:
+ - HTMX and Templ: frontend/htmx-templ.md
+ - React & Vite (TypeScript): frontend/react-vite.md
+ - Tailwind CSS: frontend/tailwind.md
- Advanced Flag:
- AF Usage: advanced-flag/advanced-flag.md
- - HTMX and Templ: advanced-flag/htmx-templ.md
- - Tailwind CSS: advanced-flag/tailwind.md
- GoReleaser & GoTest CI: advanced-flag/goreleaser.md
- Websocket: advanced-flag/websocket.md
- Docker: advanced-flag/docker.md
- - React & Vite (TypeScript): advanced-flag/react-vite.md
- Testing endpoints:
- Server: endpoints-test/server.md
- DB Health Endpoints:
diff --git a/public/frameworks.gif b/public/backends.gif
similarity index 100%
rename from public/frameworks.gif
rename to public/backends.gif
diff --git a/public/blueprint_1.png b/public/blueprint_1.png
index 093ababd..85370ffa 100644
Binary files a/public/blueprint_1.png and b/public/blueprint_1.png differ
diff --git a/public/blueprint_advanced.png b/public/blueprint_advanced.png
index 5177e0be..0865fd7d 100644
Binary files a/public/blueprint_advanced.png and b/public/blueprint_advanced.png differ
diff --git a/public/blueprint_frontend.png b/public/blueprint_frontend.png
new file mode 100644
index 00000000..4a14a8cf
Binary files /dev/null and b/public/blueprint_frontend.png differ
diff --git a/public/frontend.gif b/public/frontend.gif
new file mode 100644
index 00000000..2361b9dc
Binary files /dev/null and b/public/frontend.gif differ
Hello, { name }