mirror of
https://github.com/foss42/apidash.git
synced 2025-06-04 09:16:02 +08:00
Merge pull request #566 from Mrudul111/feature/homebrew-guide
Issue #547 Add homebrew installation support
This commit is contained in:
@ -22,7 +22,85 @@ TODO Instructions
|
|||||||
|
|
||||||
## Homebrew
|
## Homebrew
|
||||||
|
|
||||||
TODO Instructions
|
Homebrew Formula Submission
|
||||||
|
|
||||||
|
### 1. Prepare Tap Repository
|
||||||
|
|
||||||
|
```
|
||||||
|
# Create Homebrew tap
|
||||||
|
gh repo create homebrew-tap --public --clone
|
||||||
|
mkdir -p homebrew-tap/Formula
|
||||||
|
cd homebrew-tap
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Package apidash
|
||||||
|
|
||||||
|
```
|
||||||
|
# Build macOS bundle
|
||||||
|
flutter build macos
|
||||||
|
|
||||||
|
# Create versioned tarball
|
||||||
|
tar -czvf apidash-v1.0.0.tar.gz \
|
||||||
|
-C build/macos/Build/Products/Release/ \
|
||||||
|
Apidash.app
|
||||||
|
|
||||||
|
# Generate SHA256 checksum
|
||||||
|
shasum -a 256 apidash-v1.0.0.tar.gz
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Create Formula File
|
||||||
|
|
||||||
|
`Formula/apidash.rb`:
|
||||||
|
|
||||||
|
```
|
||||||
|
class Apidash < Formula
|
||||||
|
desc "Modern API dashboard for developers"
|
||||||
|
homepage "https://apidash.dev"
|
||||||
|
url "https://github.com/<user>/<repo>/releases/download/v1.0.0/apidash-v1.0.0.tar.gz"
|
||||||
|
sha256 "PASTE_YOUR_SHA256_HERE"
|
||||||
|
|
||||||
|
def install
|
||||||
|
prefix.install "Apidash.app"
|
||||||
|
bin.write_exec_script prefix/"Apidash.app/Contents/MacOS/Apidash"
|
||||||
|
end
|
||||||
|
|
||||||
|
test do
|
||||||
|
system "#{bin}/Apidash", "--version"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Local Validation
|
||||||
|
|
||||||
|
```
|
||||||
|
# Check formula syntax
|
||||||
|
brew audit --strict Formula/apidash.rb
|
||||||
|
|
||||||
|
# Test installation
|
||||||
|
brew install --build-from-source Formula/apidash.rb
|
||||||
|
|
||||||
|
# Verify execution
|
||||||
|
brew test apidash
|
||||||
|
```
|
||||||
|
|
||||||
|
### 5. Custom Tap Submission
|
||||||
|
|
||||||
|
```
|
||||||
|
# Commit formula to your tap repo
|
||||||
|
git add Formula/Apidash.rb
|
||||||
|
git commit -m "added apidash formula"
|
||||||
|
git push
|
||||||
|
|
||||||
|
# Create release for tarball
|
||||||
|
gh release create v1.0.0 apidash-v1.0.0.tar.gz
|
||||||
|
```
|
||||||
|
|
||||||
|
### 6. Installation
|
||||||
|
|
||||||
|
```
|
||||||
|
brew tap homebrew-tap/Formula
|
||||||
|
brew install apidash
|
||||||
|
```
|
||||||
|
|
||||||
## Chocolatey
|
## Chocolatey
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user