Categorygithub.com/Hell077/GoBoost
repositorypackage
0.0.0-20241230174804-83ddbab599f4
Repository: https://github.com/hell077/goboost.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

🚀 GoBoost

GoBoost is a simple tool for initializing a new Go project with a predefined structure. It also supports updating itself to the latest version with a single command.


📦 Releases

You can download pre-built binaries from the Releases section. Each release includes the latest features and fixes.


🛠 First Installation

To get started with GoBoost, follow these steps:

  1. Clone the repository:
    git clone https://github.com/Hell077/GoBoost.git
    
  2. Navigate to the project directory:
    cd path-to-project
    
  3. Build the executable:
    go build -o goBoost.exe
    
  4. Copy the executable to a desired location:
    Copy-Item -Path .\goBoost.exe -Destination "C:\Program Files\goBoost.exe"
    

⚙️ Second Installation

  1. Download the .exe file from the GoBoost Releases page.
  2. Move the downloaded file to a directory of your choice, such as:
    C:\Program Files\GoBoost
    
  3. Add GoBoost to PATH:
    • Open the Start Menu and search for "Environment Variables."
    • Select "Edit the system environment variables."
    • In the System Properties window, click on the "Environment Variables" button.
    • In the Environment Variables window, locate the "Path" variable in the "System variables" section and click "Edit."
    • Click "New" and add the path to the directory where you moved GoBoost (e.g., C:\Program Files\GoBoost).
    • Click "OK" to close all open windows and apply the changes.

📝 Usage

  • Open a command prompt, IDE, or any terminal on Windows.
  • Follow the instructions inside the program.

🔧 Commands

  • goBoost --help or goBoost --h: Displays the content of README.md.
  • goBoost --update or goBoost --u: Checks for updates and replaces the current executable with the latest version.
  • goBoost --build or goBoost --b: Automatically searches for and compiles the main.go file within the project. If . is specified, it defaults to cmd/app/main.go. The build process will handle finding the file and building the project.
  • goBoost --struct or goBoost --s: Use this command in the root of the project or in a folder to get the entire file tree.
  • goBoost --empty or goBoost --e: Use this command in the root of the project to delete all empty folders inside the project.

📂 Project Structure

GoBoost supports the following project templates:

  • Default Template: A basic project structure for general Go applications.
  • Web App Template: A template for creating web applications with configuration and API support.
  • Microservices Template: A structure for building microservices with separate services and an API gateway.
  • CLI App Template: A template for creating CLI applications with a main command and additional scripts.
  • Monorepo Template: A structure for managing multiple applications and libraries within a single repository.
  • ApiGateway Template: A organizing and managing multiple applications.microservices,library within a single repository

Tip: Always keep your GoBoost up to date for the latest features and improvements!