Skip to content

Commit

Permalink
Merge pull request #1 from MAVRICK-1/main
Browse files Browse the repository at this point in the history
refactor: rename project from go-blueprint to forgex and update relat…
  • Loading branch information
MAVRICK-1 authored Dec 10, 2024
2 parents 121b0f0 + 5c397a3 commit 5b700d1
Show file tree
Hide file tree
Showing 36 changed files with 101 additions and 101 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/update-htmx-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
go-blueprint
forgex
site
4 changes: 2 additions & 2 deletions .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ before:
- go mod tidy
- ./scripts/completions.sh
builds:
- binary: go-blueprint
- binary: forgex
main: ./
goos:
- darwin
Expand All @@ -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
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,24 +39,24 @@ gives the option to integrate with one of the more popular Go frameworks (and th
</h2>

```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

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.

<a id="frameworks-supported"></a>

Expand Down Expand Up @@ -125,7 +125,7 @@ Note: selecting tailwind option automatically selects htmx.
Blueprint UI
</h2>

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)

<a id="usage-example"></a>

Expand All @@ -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
```

<p align="center">
Expand All @@ -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
```

<p align="center">
<img src="./public/blueprint_advanced.png" alt="Advanced Options" width="800"/>
</p>

**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.**

<a id="github-stats"></a>

Expand Down
16 changes: 8 additions & 8 deletions cmd/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)

Expand Down
14 changes: 7 additions & 7 deletions cmd/program/program.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)

Expand Down
6 changes: 3 additions & 3 deletions cmd/root.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright © 2023 Melkey melkeydev@gmail.com
Copyright © 2023 Melkey DEVRhylme-Foundation@gmail.com
*/
package cmd

Expand All @@ -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!`,
Expand All @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion cmd/steps/steps.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/template/framework/chiRoutes.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/template/framework/echoRoutes.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/template/framework/fiberServer.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/template/framework/ginRoutes.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/template/framework/gorillaRoutes.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/template/framework/httpRoutes.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/template/framework/routerRoutes.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions cmd/ui/multiInput/multiInput.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions cmd/ui/multiSelect/multiSelect.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion cmd/ui/textinput/textinput.go
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down
2 changes: 1 addition & 1 deletion cmd/utils/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion cmd/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit 5b700d1

Please sign in to comment.