Skip to content

setup.md

Latest commit

 

History

History
51 lines (45 loc) · 1.2 KB

setup.md

File metadata and controls

51 lines (45 loc) · 1.2 KB

🛠️ Local Setup Guide

Follow these steps to get the project running locally:

🖥️ Requirements

  • Go 1.23+
  • A terminal emulator (e.g., bash, zsh, PowerShell)
  • Optional: Docker (for advanced testing)

📦 Installation

  1. Clone the repository: 
    git clone https://github.com/cresplanex/bloader.git
  2. Navigate into the project directory: 
    cd bloader
  3. Install dependencies: 
    go mod tidy
  4. Format the code: 
    gofumpt -extra -w .
  5. Format package imports: 
    find . -name "*.go" -not -path "./gen/*" -exec goimports -w -local github.com/cresplanex/bloader {} +
  6. Run linting: 
    golangci-lint run
  7. Run the CLI: 
    go run main.go

🚦 Testing

Run all tests using gotestsum:

gotestsum --format=short-verbose

🐢 Pro Tip

  • Use gofumpt, goimportsand golangci-lint integrations in your editor for a smooth workflow.
  • If you also want to make changes to the proto, consider introducing bufCLI commands into the editor integration flow.
  • Use Docker if you need to test integrations or other advanced features.

You're all set! 🚀