diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index d693277..d2579f9 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: true contact_links: - - name: Melkeydev Discord + - name: DEVRhylme-Foundation Discord url: https://discord.gg/HHZMSCu about: Chat with the community. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 97f8f3b..1f3f5e1 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,5 +1,5 @@ name: Feature Request -description: Suggest a new idea for go-blueprint. +description: Suggest a new idea for forgex. title: "[Feature Request] " labels: ["enhancement"] body: @@ -15,7 +15,7 @@ body: attributes: label: Tell us about your feature request description: | - Describe what you would like go-blueprint to be able to do. + Describe what you would like forgex to be able to do. validations: required: true - type: checkboxes diff --git a/.github/workflows/update-htmx-version.yml b/.github/workflows/update-htmx-version.yml index e631ebb..5955d88 100644 --- a/.github/workflows/update-htmx-version.yml +++ b/.github/workflows/update-htmx-version.yml @@ -13,7 +13,7 @@ jobs: - name: Get version from file id: get_version_file run: | - VERSION_FILE=$(curl -s https://raw.githubusercontent.com/Melkeydev/go-blueprint/main/cmd/template/advanced/files/htmx/htmx.min.js.tmpl | grep version | awk -F'"' '{print "v" $2}') + VERSION_FILE=$(curl -s https://raw.githubusercontent.com/DEVRhylme-Foundation/forgex/main/cmd/template/advanced/files/htmx/htmx.min.js.tmpl | grep version | awk -F'"' '{print "v" $2}') echo "version file: $VERSION_FILE" if [[ "$VERSION_FILE" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then echo "version_file=$VERSION_FILE" >> $GITHUB_OUTPUT diff --git a/.gitignore b/.gitignore index 64e19e5..a67013b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ -go-blueprint +forgex site diff --git a/.goreleaser.yml b/.goreleaser.yml index dbefcea..5b86cf1 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -3,7 +3,7 @@ before: - go mod tidy - ./scripts/completions.sh builds: - - binary: go-blueprint + - binary: forgex main: ./ goos: - darwin @@ -15,7 +15,7 @@ builds: env: - CGO_ENABLED=0 ldflags: - - -s -w -X github.com/melkeydev/go-blueprint/cmd.GoBlueprintVersion={{.Version}} + - -s -w -X github.com/DEVRhylme-Foundation/forgex/cmd.GoBlueprintVersion={{.Version}} release: prerelease: auto diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fa27298..5da393b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -Thanks for helping make go-blueprint better! +Thanks for helping make forgex better! - [Contributing](#contributing) - [Design Principles](#design-principles) - [Report an Issue](#report-an-issue) @@ -10,25 +10,25 @@ Thanks for helping make go-blueprint better! ## Design Principles -Contributions to go-blueprint should align with the project’s design principles: +Contributions to forgex should align with the project’s design principles: * Maintain backwards compatibility whenever possible. ## Report an Issue -If you have run into a bug or want to discuss a new feature, please [file an issue](https://github.com/Melkeydev/go-blueprint/issues). +If you have run into a bug or want to discuss a new feature, please [file an issue](https://github.com/DEVRhylme-Foundation/forgex/issues). ## Contributing Code with Pull Requests -go-blueprint uses [Github pull requests](https://github.com/Melkeydev/go-blueprint/pulls). Feel free to fork, hack away at your changes and submit. +forgex uses [Github pull requests](https://github.com/DEVRhylme-Foundation/forgex/pulls). Feel free to fork, hack away at your changes and submit. ### Requirements * All commands and functionality should be documented appropriately * All new functionality/features should have appropriate unit testing -go-blueprint strives to have a consistent set of documentation that matches the command structure and any new functionality must have accompanying documentation in the PR. +forgex strives to have a consistent set of documentation that matches the command structure and any new functionality must have accompanying documentation in the PR. ## Licensing -See the [LICENSE](https://github.com/melkeydev/go-blueprint/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. +See the [LICENSE](https://github.com/DEVRhylme-Foundation/forgex/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. diff --git a/LICENSE b/LICENSE index e6cf20a..59010b1 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2023 Melkeydev +Copyright (c) 2023 DEVRhylme-Foundation Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index ba94b60..7e4ec13 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ gives the option to integrate with one of the more popular Go frameworks (and th ```bash -go install github.com/melkeydev/go-blueprint@latest +go install github.com/DEVRhylme-Foundation/forgex@latest ``` This installs a go binary that will automatically bind to your $GOPATH @@ -47,16 +47,16 @@ This installs a go binary that will automatically bind to your $GOPATH Then in a new terminal run: ```bash -go-blueprint create +forgex create ``` You can also use the provided flags to set up a project without interacting with the UI. ```bash -go-blueprint create --name my-project --framework gin --driver postgres --git commit +forgex create --name my-project --framework gin --driver postgres --git commit ``` -See `go-blueprint create -h` for all the options and shorthands. +See `forgex create -h` for all the options and shorthands. @@ -125,7 +125,7 @@ Note: selecting tailwind option automatically selects htmx. Blueprint UI -Blueprint UI is a web application that allows you to create commands for the CLI and preview the structure of your project. You will be able to see directories and files that will be created upon command execution. Check it out at [go-blueprint.dev](https://go-blueprint.dev) +Blueprint UI is a web application that allows you to create commands for the CLI and preview the structure of your project. You will be able to see directories and files that will be created upon command execution. Check it out at [forgex.dev](https://forgex.dev) @@ -139,7 +139,7 @@ Blueprint UI is a web application that allows you to create commands for the CLI Here's an example of setting up a project with a specific database driver: ```bash -go-blueprint create --name my-project --framework gin --driver postgres --git commit +forgex create --name my-project --framework gin --driver postgres --git commit ```

@@ -149,46 +149,46 @@ go-blueprint create --name my-project --framework gin --driver postgres --git co Advanced features are accessible with the --advanced flag ```bash -go-blueprint create --advanced +forgex create --advanced ``` Advanced features can be enabled using the `--feature` flag along with the `--advanced` flag. HTMX: ```bash -go-blueprint create --advanced --feature htmx +forgex create --advanced --feature htmx ``` CI/CD workflow: ```bash -go-blueprint create --advanced --feature githubaction +forgex create --advanced --feature githubaction ``` Websocket: ```bash -go-blueprint create --advanced --feature websocket +forgex create --advanced --feature websocket ``` Tailwind: ```bash -go-blueprint create --advanced --feature tailwind +forgex create --advanced --feature tailwind ``` Docker: ```bash -go-blueprint create --advanced --feature docker +forgex create --advanced --feature docker ``` Or all features at once: ```bash -go-blueprint create --name my-project --framework chi --driver mysql --advanced --feature htmx --feature githubaction --feature websocket --feature tailwind --feature docker -git commit +forgex create --name my-project --framework chi --driver mysql --advanced --feature htmx --feature githubaction --feature websocket --feature tailwind --feature docker -git commit ```

Advanced Options

- **Visit [documentation](https://docs.go-blueprint.dev) to learn more about blueprint and its features.** + **Visit [documentation](https://docs.forgex.dev) to learn more about blueprint and its features.** diff --git a/cmd/create.go b/cmd/create.go index d1d404c..c0b3211 100644 --- a/cmd/create.go +++ b/cmd/create.go @@ -7,16 +7,16 @@ import ( "strings" "sync" + "github.com/DEVRhylme-Foundation/forgex/cmd/flags" + "github.com/DEVRhylme-Foundation/forgex/cmd/program" + "github.com/DEVRhylme-Foundation/forgex/cmd/steps" + "github.com/DEVRhylme-Foundation/forgex/cmd/ui/multiInput" + "github.com/DEVRhylme-Foundation/forgex/cmd/ui/multiSelect" + "github.com/DEVRhylme-Foundation/forgex/cmd/ui/spinner" + "github.com/DEVRhylme-Foundation/forgex/cmd/ui/textinput" + "github.com/DEVRhylme-Foundation/forgex/cmd/utils" tea "github.com/charmbracelet/bubbletea" "github.com/charmbracelet/lipgloss" - "github.com/melkeydev/go-blueprint/cmd/flags" - "github.com/melkeydev/go-blueprint/cmd/program" - "github.com/melkeydev/go-blueprint/cmd/steps" - "github.com/melkeydev/go-blueprint/cmd/ui/multiInput" - "github.com/melkeydev/go-blueprint/cmd/ui/multiSelect" - "github.com/melkeydev/go-blueprint/cmd/ui/spinner" - "github.com/melkeydev/go-blueprint/cmd/ui/textinput" - "github.com/melkeydev/go-blueprint/cmd/utils" "github.com/spf13/cobra" ) diff --git a/cmd/program/program.go b/cmd/program/program.go index ea8c7c5..4b0d939 100644 --- a/cmd/program/program.go +++ b/cmd/program/program.go @@ -12,14 +12,14 @@ import ( "strings" "text/template" + "github.com/DEVRhylme-Foundation/forgex/cmd/flags" + tpl "github.com/DEVRhylme-Foundation/forgex/cmd/template" + "github.com/DEVRhylme-Foundation/forgex/cmd/template/advanced" + "github.com/DEVRhylme-Foundation/forgex/cmd/template/dbdriver" + "github.com/DEVRhylme-Foundation/forgex/cmd/template/docker" + "github.com/DEVRhylme-Foundation/forgex/cmd/template/framework" + "github.com/DEVRhylme-Foundation/forgex/cmd/utils" tea "github.com/charmbracelet/bubbletea" - "github.com/melkeydev/go-blueprint/cmd/flags" - tpl "github.com/melkeydev/go-blueprint/cmd/template" - "github.com/melkeydev/go-blueprint/cmd/template/advanced" - "github.com/melkeydev/go-blueprint/cmd/template/dbdriver" - "github.com/melkeydev/go-blueprint/cmd/template/docker" - "github.com/melkeydev/go-blueprint/cmd/template/framework" - "github.com/melkeydev/go-blueprint/cmd/utils" "github.com/spf13/cobra" ) diff --git a/cmd/root.go b/cmd/root.go index 43dd645..56055b9 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -1,5 +1,5 @@ /* -Copyright © 2023 Melkey melkeydev@gmail.com +Copyright © 2023 Melkey DEVRhylme-Foundation@gmail.com */ package cmd @@ -11,7 +11,7 @@ import ( // rootCmd represents the base command when called without any subcommands var rootCmd = &cobra.Command{ - Use: "go-blueprint", + Use: "forgex", Short: "A program to spin up a quick Go project using a popular framework", Long: `Go Blueprint is a CLI tool that allows users to spin up a Go project with the corresponding structure seamlessly. It also gives the option to integrate with one of the more popular Go frameworks!`, @@ -31,7 +31,7 @@ func init() { // Cobra supports persistent flags, which, if defined here, // will be global for your application. - // rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.go-blueprint.yaml)") + // rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.forgex.yaml)") // Cobra also supports local flags, which will only run // when this action is called directly. diff --git a/cmd/steps/steps.go b/cmd/steps/steps.go index 9074d61..3afee9d 100644 --- a/cmd/steps/steps.go +++ b/cmd/steps/steps.go @@ -2,7 +2,7 @@ // each step of the CLI package steps -import "github.com/melkeydev/go-blueprint/cmd/flags" +import "github.com/DEVRhylme-Foundation/forgex/cmd/flags" // A StepSchema contains the data that is used // for an individual step of the CLI diff --git a/cmd/template/framework/chiRoutes.go b/cmd/template/framework/chiRoutes.go index 00fbda8..aa24744 100644 --- a/cmd/template/framework/chiRoutes.go +++ b/cmd/template/framework/chiRoutes.go @@ -3,7 +3,7 @@ package framework import ( _ "embed" - "github.com/melkeydev/go-blueprint/cmd/template/advanced" + "github.com/DEVRhylme-Foundation/forgex/cmd/template/advanced" ) //go:embed files/routes/chi.go.tmpl diff --git a/cmd/template/framework/echoRoutes.go b/cmd/template/framework/echoRoutes.go index cb25939..bc31c4f 100644 --- a/cmd/template/framework/echoRoutes.go +++ b/cmd/template/framework/echoRoutes.go @@ -3,7 +3,7 @@ package framework import ( _ "embed" - "github.com/melkeydev/go-blueprint/cmd/template/advanced" + "github.com/DEVRhylme-Foundation/forgex/cmd/template/advanced" ) //go:embed files/routes/echo.go.tmpl diff --git a/cmd/template/framework/fiberServer.go b/cmd/template/framework/fiberServer.go index 961e4d9..f39fb4c 100644 --- a/cmd/template/framework/fiberServer.go +++ b/cmd/template/framework/fiberServer.go @@ -3,7 +3,7 @@ package framework import ( _ "embed" - "github.com/melkeydev/go-blueprint/cmd/template/advanced" + "github.com/DEVRhylme-Foundation/forgex/cmd/template/advanced" ) //go:embed files/routes/fiber.go.tmpl diff --git a/cmd/template/framework/ginRoutes.go b/cmd/template/framework/ginRoutes.go index 1a952d5..58b051e 100644 --- a/cmd/template/framework/ginRoutes.go +++ b/cmd/template/framework/ginRoutes.go @@ -3,7 +3,7 @@ package framework import ( _ "embed" - "github.com/melkeydev/go-blueprint/cmd/template/advanced" + "github.com/DEVRhylme-Foundation/forgex/cmd/template/advanced" ) //go:embed files/routes/gin.go.tmpl diff --git a/cmd/template/framework/gorillaRoutes.go b/cmd/template/framework/gorillaRoutes.go index aa2711f..ef56ce1 100644 --- a/cmd/template/framework/gorillaRoutes.go +++ b/cmd/template/framework/gorillaRoutes.go @@ -3,7 +3,7 @@ package framework import ( _ "embed" - "github.com/melkeydev/go-blueprint/cmd/template/advanced" + "github.com/DEVRhylme-Foundation/forgex/cmd/template/advanced" ) //go:embed files/routes/gorilla.go.tmpl diff --git a/cmd/template/framework/httpRoutes.go b/cmd/template/framework/httpRoutes.go index b0170a8..af311bf 100644 --- a/cmd/template/framework/httpRoutes.go +++ b/cmd/template/framework/httpRoutes.go @@ -3,7 +3,7 @@ package framework import ( _ "embed" - "github.com/melkeydev/go-blueprint/cmd/template/advanced" + "github.com/DEVRhylme-Foundation/forgex/cmd/template/advanced" ) //go:embed files/routes/standard_library.go.tmpl diff --git a/cmd/template/framework/routerRoutes.go b/cmd/template/framework/routerRoutes.go index f9e9213..fa0be1b 100644 --- a/cmd/template/framework/routerRoutes.go +++ b/cmd/template/framework/routerRoutes.go @@ -3,7 +3,7 @@ package framework import ( _ "embed" - "github.com/melkeydev/go-blueprint/cmd/template/advanced" + "github.com/DEVRhylme-Foundation/forgex/cmd/template/advanced" ) //go:embed files/routes/http_router.go.tmpl diff --git a/cmd/ui/multiInput/multiInput.go b/cmd/ui/multiInput/multiInput.go index e3067f4..1779f4c 100644 --- a/cmd/ui/multiInput/multiInput.go +++ b/cmd/ui/multiInput/multiInput.go @@ -5,8 +5,8 @@ package multiInput import ( "fmt" - "github.com/melkeydev/go-blueprint/cmd/program" - "github.com/melkeydev/go-blueprint/cmd/steps" + "github.com/DEVRhylme-Foundation/forgex/cmd/program" + "github.com/DEVRhylme-Foundation/forgex/cmd/steps" tea "github.com/charmbracelet/bubbletea" "github.com/charmbracelet/lipgloss" diff --git a/cmd/ui/multiSelect/multiSelect.go b/cmd/ui/multiSelect/multiSelect.go index 3b5fec0..8d07ded 100644 --- a/cmd/ui/multiSelect/multiSelect.go +++ b/cmd/ui/multiSelect/multiSelect.go @@ -5,8 +5,8 @@ package multiSelect import ( "fmt" - "github.com/melkeydev/go-blueprint/cmd/program" - "github.com/melkeydev/go-blueprint/cmd/steps" + "github.com/DEVRhylme-Foundation/forgex/cmd/program" + "github.com/DEVRhylme-Foundation/forgex/cmd/steps" tea "github.com/charmbracelet/bubbletea" "github.com/charmbracelet/lipgloss" diff --git a/cmd/ui/textinput/textinput.go b/cmd/ui/textinput/textinput.go index 5992acf..044c079 100644 --- a/cmd/ui/textinput/textinput.go +++ b/cmd/ui/textinput/textinput.go @@ -7,10 +7,10 @@ import ( "fmt" "regexp" + "github.com/DEVRhylme-Foundation/forgex/cmd/program" "github.com/charmbracelet/bubbles/textinput" tea "github.com/charmbracelet/bubbletea" "github.com/charmbracelet/lipgloss" - "github.com/melkeydev/go-blueprint/cmd/program" ) var ( diff --git a/cmd/utils/utils.go b/cmd/utils/utils.go index 9a1f9bc..d6da9ca 100644 --- a/cmd/utils/utils.go +++ b/cmd/utils/utils.go @@ -12,7 +12,7 @@ import ( "github.com/spf13/pflag" ) -const ProgramName = "go-blueprint" +const ProgramName = "forgex" // NonInteractiveCommand creates the command string from a flagSet // to be used for getting the equivalent non-interactive shell command diff --git a/cmd/version.go b/cmd/version.go index 8ea581d..5da7ffa 100644 --- a/cmd/version.go +++ b/cmd/version.go @@ -21,7 +21,7 @@ var GoBlueprintVersion string // This won't give any version info when running 'go install' with the source code locally. // Finally we try to get the version from other embedded VCS info. func getGoBlueprintVersion() string { - noVersionAvailable := "No version info available for this build, run 'go-blueprint help version' for additional info" + noVersionAvailable := "No version info available for this build, run 'forgex help version' for additional info" if len(GoBlueprintVersion) != 0 { return GoBlueprintVersion diff --git a/contributors.yml b/contributors.yml index e1c6a36..d332593 100644 --- a/contributors.yml +++ b/contributors.yml @@ -1,4 +1,4 @@ -- Melkeydev +- DEVRhylme-Foundation - Ujstor - tylermeekel - MitchellBerend diff --git a/docs/custom_theme/main.html b/docs/custom_theme/main.html index a017e59..1bed0cb 100644 --- a/docs/custom_theme/main.html +++ b/docs/custom_theme/main.html @@ -2,5 +2,5 @@ {% block libs %} {{ super() }} - + {% endblock %} diff --git a/docs/docs/advanced-flag/advanced-flag.md b/docs/docs/advanced-flag/advanced-flag.md index 0051114..525f10b 100644 --- a/docs/docs/advanced-flag/advanced-flag.md +++ b/docs/docs/advanced-flag/advanced-flag.md @@ -17,18 +17,18 @@ Adds Tailwind CSS support to the project. To utilize the `--advanced` flag, use the following command: ```bash -go-blueprint create --name --framework --driver --advanced +forgex create --name --framework --driver --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. 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 +forgex create --name my-project --framework chi --driver mysql --advanced ``` 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 +forgex create --name my-project --framework chi --driver mysql --advanced --feature htmx --feature githubaction --feature websocket --feature tailwind ``` diff --git a/docs/docs/advanced-flag/websocket.md b/docs/docs/advanced-flag/websocket.md index c7bea3a..fe7c9a5 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 forgex supported frameworks. This simple implementation showcases how flexible project is. ### Code Implementation diff --git a/docs/docs/blueprint-ui.md b/docs/docs/blueprint-ui.md index a7f9e20..0dc37df 100644 --- a/docs/docs/blueprint-ui.md +++ b/docs/docs/blueprint-ui.md @@ -1,7 +1,7 @@ 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. +By visiting the Blueprint UI website at [forgex.dev](https://forgex.dev), users can interact with a visual representation of their project setup before executing commands. ![BlueprintUI](public/blueprint_ui.png) -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). +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/forgex-htmx). diff --git a/docs/docs/creating-project/project-init.md b/docs/docs/creating-project/project-init.md index 9eae177..7a5c7e3 100644 --- a/docs/docs/creating-project/project-init.md +++ b/docs/docs/creating-project/project-init.md @@ -1,9 +1,9 @@ ## Creating a Project -After installing the Go-Blueprint CLI tool, you can create a new project with the default settings by running the following command: +After installing the forgex CLI tool, you can create a new project with the default settings by running the following command: ```bash -go-blueprint create +forgex create ``` This command will interactively guide you through the project setup process, allowing you to choose the project name, framework, and database driver. @@ -15,7 +15,7 @@ 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 +forgex create --name my-project --framework gin --driver postgres --git commit ``` In this example: @@ -32,12 +32,12 @@ Customize the flags according to your project requirements. 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. ```bash -go-blueprint create --advanced +forgex create --advanced ``` 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 --git commit --advanced +forgex create --name my-project --framework chi --driver mysql --git commit --advanced ``` This approach opens interactive mode only for advanced features, which allow you to choose the one or combination of available features. @@ -49,28 +49,28 @@ Advanced features can be enabled using the `--feature` flag along with the `--ad HTMX: ```bash -go-blueprint create --advanced --feature htmx +forgex create --advanced --feature htmx ``` CI/CD workflow: ```bash -go-blueprint create --advanced --feature githubaction +forgex create --advanced --feature githubaction ``` Websocket: ```bash -go-blueprint create --advanced --feature websocket +forgex create --advanced --feature websocket ``` TailwindCSS: ```bash -go-blueprint create --advanced --feature tailwind +forgex create --advanced --feature tailwind ``` Docker: ```bash -go-blueprint create --advanced --feature docker +forgex create --advanced --feature docker ``` 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 +forgex create --name my-project --framework chi --driver mysql --git commit --advanced --feature htmx --feature githubaction --feature websocket --feature tailwind --feature docker ``` diff --git a/docs/docs/endpoints-test/server.md b/docs/docs/endpoints-test/server.md index ff788f2..3a21362 100644 --- a/docs/docs/endpoints-test/server.md +++ b/docs/docs/endpoints-test/server.md @@ -1,6 +1,6 @@ ## Testing Endpoints with CURL and WebSocat -Testing endpoints is an essential part of ensuring the correctness and functionality of your app. Depending on what options are used for go-blueprint project creation, you have various endpoints for testing your init application status. +Testing endpoints is an essential part of ensuring the correctness and functionality of your app. Depending on what options are used for forgex project creation, you have various endpoints for testing your init application status. Before proceeding, ensure you have the following tools installed: diff --git a/docs/docs/installation.md b/docs/docs/installation.md index c2fa9c3..a7f280b 100644 --- a/docs/docs/installation.md +++ b/docs/docs/installation.md @@ -2,30 +2,30 @@ hide: - toc --- -Go-Blueprint provides a convenient CLI tool to effortlessly set up your Go projects. Follow the steps below to install the tool on your system. +forgex provides a convenient CLI tool to effortlessly set up your Go projects. Follow the steps below to install the tool on your system. ## Binary Installation -To install the Go-Blueprint CLI tool as a binary, Run the following command: +To install the forgex CLI tool as a binary, Run the following command: ```sh -go install github.com/melkeydev/go-blueprint@latest +go install github.com/DEVRhylme-Foundation/forgex@latest ``` -This command installs the Go-Blueprint binary, automatically binding it to your `$GOPATH`. +This command installs the forgex binary, automatically binding it to your `$GOPATH`. ## Building and Installing from Source -If you prefer to build and install Go-Blueprint directly from the source code, you can follow these steps: +If you prefer to build and install forgex directly from the source code, you can follow these steps: -Clone the Go-Blueprint repository from GitHub: +Clone the forgex repository from GitHub: ```sh -git clone https://github.com/melkeydev/go-blueprint +git clone https://github.com/DEVRhylme-Foundation/forgex ``` -Build the Go-Blueprint binary: +Build the forgex binary: ```sh go build @@ -39,9 +39,9 @@ go install Verify the installation by running: ```sh -go-blueprint version +forgex version ``` -This should display the version information of the installed Go-Blueprint. +This should display the version information of the installed forgex. -Now you have successfully built and installed Go-Blueprint from the source code. +Now you have successfully built and installed forgex from the source code. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 96be7fd..f512ba8 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,10 +1,10 @@ ### Site metadata ### -site_name: Go-Blueprint Docs -site_description: Official documentation for Go-Blueprint project -site_url: https://docs.go-blueprint.dev/ +site_name: forgex Docs +site_description: Official documentation for forgex project +site_url: https://docs.forgex.dev/ -repo_url: https://github.com/Melkeydev/go-blueprint +repo_url: https://github.com/DEVRhylme-Foundation/forgex edit_uri: edit/main/docs/docs ### Build settings ### @@ -64,10 +64,10 @@ extra: link: https://www.twitch.tv/melkey name: Twitch - icon: fontawesome/brands/youtube - link: https://www.youtube.com/@MelkeyDev + link: https://www.youtube.com/@DEVRhylme-Foundation name: YouTube - icon: fontawesome/brands/twitter - link: https://x.com/MelkeyDev + link: https://x.com/DEVRhylme-Foundation name: Twitter generator: false diff --git a/go.mod b/go.mod index 88501fc..f61beb6 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module github.com/melkeydev/go-blueprint +module github.com/DEVRhylme-Foundation/forgex go 1.22.4 diff --git a/main.go b/main.go index 2cedc50..bd86cb4 100644 --- a/main.go +++ b/main.go @@ -1,6 +1,6 @@ package main -import "github.com/melkeydev/go-blueprint/cmd" +import "github.com/DEVRhylme-Foundation/forgex/cmd" func main() { cmd.Execute() diff --git a/scripts/completions.sh b/scripts/completions.sh index 09d206f..4e812a4 100755 --- a/scripts/completions.sh +++ b/scripts/completions.sh @@ -3,5 +3,5 @@ set -e rm -rf completions mkdir completions for sh in bash zsh fish; do - go run main.go completion "$sh" >"completions/go-blueprint.$sh" + go run main.go completion "$sh" >"completions/forgex.$sh" done