Skip to content

Commit

Permalink
refactor: update references from Blueprint to ForgeX across the proje…
Browse files Browse the repository at this point in the history
…ct (#2)
  • Loading branch information
MAVRICK-1 authored Dec 10, 2024
1 parent 5b700d1 commit 915abdf
Show file tree
Hide file tree
Showing 32 changed files with 183 additions and 183 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/generate-linter-advanced.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Linting Generated Blueprints Advanced
name: Linting Generated ForgeXs Advanced

on:
pull_request: {}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/generate-linter-core.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Linting Generated Blueprints Core
name: Linting Generated ForgeXs Core

on:
pull_request: {}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/testcontainers.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Integrations Test for the Generated Blueprints
name: Integrations Test for the Generated ForgeXs

on:
pull_request: {}
Expand Down
2 changes: 1 addition & 1 deletion .goreleaser.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ builds:
env:
- CGO_ENABLED=0
ldflags:
- -s -w -X github.com/DEVRhylme-Foundation/forgex/cmd.GoBlueprintVersion={{.Version}}
- -s -w -X github.com/DEVRhylme-Foundation/forgex/cmd.GoForgeXVersion={{.Version}}

release:
prerelease: auto
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

<div style="text-align: center;">
<h1>
Introducing the Ultimate Golang Blueprint Library
Introducing the Ultimate Golang ForgeX Library
</h1>
</div>

Go Blueprint is a CLI tool that allows users to spin up a Go project with the corresponding structure seamlessly. It also
Go ForgeX 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 (and the list is growing with new features)!

### Why Would I use this?
Expand All @@ -24,7 +24,7 @@ gives the option to integrate with one of the more popular Go frameworks (and th
- [Frameworks Supported](#frameworks-supported)
- [Database Support](#database-support)
- [Advanced Features](#advanced-features)
- [Blueprint UI](#blueprint-ui)
- [ForgeX UI](#ForgeX-ui)
- [Usage Example](#usage-example)
- [GitHub Stats](#github-stats)
- [License](#license)
Expand Down Expand Up @@ -83,7 +83,7 @@ See `forgex create -h` for all the options and shorthands.
Database Support
</h2>

Go Blueprint now offers enhanced database support, allowing you to choose your preferred database driver during project setup. Use the `--driver` or `-d` flag to specify the database driver you want to integrate into your project.
Go ForgeX now offers enhanced database support, allowing you to choose your preferred database driver during project setup. Use the `--driver` or `-d` flag to specify the database driver you want to integrate into your project.

### Supported Database Drivers

Expand All @@ -104,7 +104,7 @@ Choose from a variety of supported database drivers:
Advanced Features
</h2>

Blueprint is focused on being as minimalistic as possible. That being said, we wanted to offer the ability to add other features people may want without bloating the overall experience.
ForgeX is focused on being as minimalistic as possible. That being said, we wanted to offer the ability to add other features people may want without bloating the overall experience.

You can now use the `--advanced` flag when running the `create` command to get access to the following features. This is a multi-option prompt; one or more features can be used at the same time:

Expand All @@ -116,16 +116,16 @@ You can now use the `--advanced` flag when running the `create` command to get a

Note: selecting tailwind option automatically selects htmx.

<a id="blueprint-ui"></a>
<a id="ForgeX-ui"></a>

<h2>
<picture>
<img src="./public/ui.gif?raw=true" width="100px" style="margin-right: 1px;">
</picture>
Blueprint UI
ForgeX 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 [forgex.dev](https://forgex.dev)
ForgeX 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 @@ -143,7 +143,7 @@ forgex create --name my-project --framework gin --driver postgres --git commit
```

<p align="center">
<img src="./public/blueprint_1.png" alt="Starter Image" width="800"/>
<img src="./public/ForgeX_1.png" alt="Starter Image" width="800"/>
</p>

Advanced features are accessible with the --advanced flag
Expand Down Expand Up @@ -185,10 +185,10 @@ forgex create --name my-project --framework chi --driver mysql --advanced --feat
```

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

**Visit [documentation](https://docs.forgex.dev) to learn more about blueprint and its features.**
**Visit [documentation](https://docs.forgex.dev) to learn more about ForgeX and its features.**

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

Expand Down
20 changes: 10 additions & 10 deletions cmd/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,14 +22,14 @@ import (

const logo = `
____ _ _ _
| _ \| | (_) | |
| |_) | |_ _ ___ _ __ _ __ _ _ __ | |_
| _ <| | | | |/ _ \ '_ \| '__| | '_ \| __|
| |_) | | |_| | __/ |_) | | | | | | | |_
|____/|_|\__,_|\___| .__/|_| |_|_| |_|\__|
| |
|_|
_____ __ __
| ___| \ \/ /
| |_ ___ _ __ __ _ ___ \ /
| _/ _ \| '__/ _' |/ _ \ / \
| || (_) | | | (_| | __/ / /\ \
\_| \___/|_| \__, |\___| /_/ \_\
__/ |
|___/
`

Expand Down Expand Up @@ -67,7 +67,7 @@ type Options struct {
var createCmd = &cobra.Command{
Use: "create",
Short: "Create a Go project and don't worry about the structure",
Long: "Go Blueprint is a CLI tool that allows you to focus on the actual Go code, and not the project structure. Perfect for someone new to the Go language",
Long: "Go ForgeX is a CLI tool that allows you to focus on the actual Go code, and not the project structure. Perfect for someone new to the Go language",

Run: func(cmd *cobra.Command, args []string) {
var tprogram *tea.Program
Expand Down Expand Up @@ -293,7 +293,7 @@ var createCmd = &cobra.Command{

if isInteractive {
nonInteractiveCommand := utils.NonInteractiveCommand(cmd.Use, cmd.Flags())
fmt.Println(tipMsgStyle.Render("Tip: Repeat the equivalent Blueprint with the following non-interactive command:"))
fmt.Println(tipMsgStyle.Render("Tip: Repeat the equivalent ForgeX with the following non-interactive command:"))
fmt.Println(tipMsgStyle.Italic(false).Render(fmt.Sprintf("• %s\n", nonInteractiveCommand)))
}
err = spinner.ReleaseTerminal()
Expand Down
2 changes: 1 addition & 1 deletion cmd/program/program.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Package program provides the
// main functionality of Blueprint
// main functionality of ForgeX
package program

import (
Expand Down
4 changes: 2 additions & 2 deletions cmd/root.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright © 2023 Melkey [email protected]
Copyright © 2024 [email protected]
*/
package cmd

Expand All @@ -13,7 +13,7 @@ import (
var rootCmd = &cobra.Command{
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.
Long: `Go ForgeX 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 Down
2 changes: 1 addition & 1 deletion cmd/template/advanced/files/docker/docker_compose.yml.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ services:
APP_ENV: ${APP_ENV}
PORT: ${PORT}
{{- if and (.AdvancedOptions.docker) (eq .DBDriver "sqlite") }}
BLUEPRINT_DB_URL: ${BLUEPRINT_DB_URL}
ForgeX_DB_URL: ${ForgeX_DB_URL}
volumes:
- sqlite_bp:/app/db

Expand Down
2 changes: 1 addition & 1 deletion cmd/template/advanced/files/htmx/base.templ.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ templ Base() {
<html lang="en" {{if .AdvancedOptions.tailwind}}class="h-screen"{{end}}>
<head>
<meta charset="utf-8"/>
<title>Go Blueprint Hello</title>
<title>Go ForgeX Hello</title>
<link href="assets/css/output.css" rel="stylesheet"/>
<script src="assets/js/htmx.min.js"></script>
</head>
Expand Down
10 changes: 5 additions & 5 deletions cmd/template/dbdriver/files/env/mongo.tmpl
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{{ if .AdvancedOptions.docker }}
BLUEPRINT_DB_HOST=mongo_bp
ForgeX_DB_HOST=mongo_bp
{{- else }}
BLUEPRINT_DB_HOST=localhost
ForgeX_DB_HOST=localhost
{{- end }}
BLUEPRINT_DB_PORT=27017
BLUEPRINT_DB_USERNAME=melkey
BLUEPRINT_DB_ROOT_PASSWORD=password1234
ForgeX_DB_PORT=27017
ForgeX_DB_USERNAME=melkey
ForgeX_DB_ROOT_PASSWORD=password1234
14 changes: 7 additions & 7 deletions cmd/template/dbdriver/files/env/mysql.tmpl
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{{- if .AdvancedOptions.docker }}
BLUEPRINT_DB_HOST=mysql_bp
ForgeX_DB_HOST=mysql_bp
{{- else }}
BLUEPRINT_DB_HOST=localhost
ForgeX_DB_HOST=localhost
{{- end }}
BLUEPRINT_DB_PORT=3306
BLUEPRINT_DB_DATABASE=blueprint
BLUEPRINT_DB_USERNAME=melkey
BLUEPRINT_DB_PASSWORD=password1234
BLUEPRINT_DB_ROOT_PASSWORD=password4321
ForgeX_DB_PORT=3306
ForgeX_DB_DATABASE=ForgeX
ForgeX_DB_USERNAME=melkey
ForgeX_DB_PASSWORD=password1234
ForgeX_DB_ROOT_PASSWORD=password4321
14 changes: 7 additions & 7 deletions cmd/template/dbdriver/files/env/postgres.tmpl
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{{- if .AdvancedOptions.docker }}
BLUEPRINT_DB_HOST=psql_bp
ForgeX_DB_HOST=psql_bp
{{- else }}
BLUEPRINT_DB_HOST=localhost
ForgeX_DB_HOST=localhost
{{- end }}
BLUEPRINT_DB_PORT=5432
BLUEPRINT_DB_DATABASE=blueprint
BLUEPRINT_DB_USERNAME=melkey
BLUEPRINT_DB_PASSWORD=password1234
BLUEPRINT_DB_SCHEMA=public
ForgeX_DB_PORT=5432
ForgeX_DB_DATABASE=ForgeX
ForgeX_DB_USERNAME=melkey
ForgeX_DB_PASSWORD=password1234
ForgeX_DB_SCHEMA=public
10 changes: 5 additions & 5 deletions cmd/template/dbdriver/files/env/redis.tmpl
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{{- if .AdvancedOptions.docker }}
BLUEPRINT_DB_ADDRESS=redis_bp
ForgeX_DB_ADDRESS=redis_bp
{{- else }}
BLUEPRINT_DB_ADDRESS=localhost
ForgeX_DB_ADDRESS=localhost
{{- end }}
BLUEPRINT_DB_PORT=6379
BLUEPRINT_DB_PASSWORD=
BLUEPRINT_DB_DATABASE=0
ForgeX_DB_PORT=6379
ForgeX_DB_PASSWORD=
ForgeX_DB_DATABASE=0
4 changes: 2 additions & 2 deletions cmd/template/dbdriver/files/env/sqlite.tmpl
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{- if .AdvancedOptions.docker }}
BLUEPRINT_DB_URL=./db/test.db
ForgeX_DB_URL=./db/test.db
{{- else }}
BLUEPRINT_DB_URL=./test.db
ForgeX_DB_URL=./test.db
{{- end }}
6 changes: 3 additions & 3 deletions cmd/template/dbdriver/files/service/mongo.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ type service struct {
}

var (
host = os.Getenv("BLUEPRINT_DB_HOST")
port = os.Getenv("BLUEPRINT_DB_PORT")
//database = os.Getenv("BLUEPRINT_DB_DATABASE")
host = os.Getenv("ForgeX_DB_HOST")
port = os.Getenv("ForgeX_DB_PORT")
//database = os.Getenv("ForgeX_DB_DATABASE")
)

func New() Service {
Expand Down
10 changes: 5 additions & 5 deletions cmd/template/dbdriver/files/service/mysql.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ type service struct {
}

var (
dbname = os.Getenv("BLUEPRINT_DB_DATABASE")
password = os.Getenv("BLUEPRINT_DB_PASSWORD")
username = os.Getenv("BLUEPRINT_DB_USERNAME")
port = os.Getenv("BLUEPRINT_DB_PORT")
host = os.Getenv("BLUEPRINT_DB_HOST")
dbname = os.Getenv("ForgeX_DB_DATABASE")
password = os.Getenv("ForgeX_DB_PASSWORD")
username = os.Getenv("ForgeX_DB_USERNAME")
port = os.Getenv("ForgeX_DB_PORT")
host = os.Getenv("ForgeX_DB_HOST")
dbInstance *service
)

Expand Down
12 changes: 6 additions & 6 deletions cmd/template/dbdriver/files/service/postgres.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ type service struct {
}

var (
database = os.Getenv("BLUEPRINT_DB_DATABASE")
password = os.Getenv("BLUEPRINT_DB_PASSWORD")
username = os.Getenv("BLUEPRINT_DB_USERNAME")
port = os.Getenv("BLUEPRINT_DB_PORT")
host = os.Getenv("BLUEPRINT_DB_HOST")
schema = os.Getenv("BLUEPRINT_DB_SCHEMA")
database = os.Getenv("ForgeX_DB_DATABASE")
password = os.Getenv("ForgeX_DB_PASSWORD")
username = os.Getenv("ForgeX_DB_USERNAME")
port = os.Getenv("ForgeX_DB_PORT")
host = os.Getenv("ForgeX_DB_HOST")
schema = os.Getenv("ForgeX_DB_SCHEMA")
dbInstance *service
)

Expand Down
8 changes: 4 additions & 4 deletions cmd/template/dbdriver/files/service/redis.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ type service struct {
}

var (
address = os.Getenv("BLUEPRINT_DB_ADDRESS")
port = os.Getenv("BLUEPRINT_DB_PORT")
password = os.Getenv("BLUEPRINT_DB_PASSWORD")
database = os.Getenv("BLUEPRINT_DB_DATABASE")
address = os.Getenv("ForgeX_DB_ADDRESS")
port = os.Getenv("ForgeX_DB_PORT")
password = os.Getenv("ForgeX_DB_PASSWORD")
database = os.Getenv("ForgeX_DB_DATABASE")
)

func New() Service {
Expand Down
2 changes: 1 addition & 1 deletion cmd/template/dbdriver/files/service/sqlite.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ type service struct {
}

var (
dburl = os.Getenv("BLUEPRINT_DB_URL")
dburl = os.Getenv("ForgeX_DB_URL")
dbInstance *service
)

Expand Down
20 changes: 10 additions & 10 deletions cmd/template/docker/files/docker-compose/mongo.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,24 @@ services:
environment:
APP_ENV: ${APP_ENV}
PORT: ${PORT}
BLUEPRINT_DB_HOST: ${BLUEPRINT_DB_HOST}
BLUEPRINT_DB_PORT: ${BLUEPRINT_DB_PORT}
BLUEPRINT_DB_USERNAME: ${BLUEPRINT_DB_USERNAME}
BLUEPRINT_DB_ROOT_PASSWORD: ${BLUEPRINT_DB_ROOT_PASSWORD}
ForgeX_DB_HOST: ${ForgeX_DB_HOST}
ForgeX_DB_PORT: ${ForgeX_DB_PORT}
ForgeX_DB_USERNAME: ${ForgeX_DB_USERNAME}
ForgeX_DB_ROOT_PASSWORD: ${ForgeX_DB_ROOT_PASSWORD}
depends_on:
mongo_bp:
condition: service_healthy
networks:
- blueprint
- ForgeX
{{- end }}
mongo_bp:
image: mongo:latest
restart: unless-stopped
environment:
MONGO_INITDB_ROOT_USERNAME: ${BLUEPRINT_DB_USERNAME}
MONGO_INITDB_ROOT_PASSWORD: ${BLUEPRINT_DB_ROOT_PASSWORD}
MONGO_INITDB_ROOT_USERNAME: ${ForgeX_DB_USERNAME}
MONGO_INITDB_ROOT_PASSWORD: ${ForgeX_DB_ROOT_PASSWORD}
ports:
- "${BLUEPRINT_DB_PORT}:27017"
- "${ForgeX_DB_PORT}:27017"
volumes:
- mongo_volume_bp:/data/db
{{- if .AdvancedOptions.docker }}
Expand All @@ -39,12 +39,12 @@ services:
retries: 3
start_period: 15s
networks:
- blueprint
- ForgeX
{{- end }}

volumes:
mongo_volume_bp:
{{- if .AdvancedOptions.docker }}
networks:
blueprint:
ForgeX:
{{- end }}
Loading

0 comments on commit 915abdf

Please sign in to comment.