Skip to content

Commit 7ee42ae

Browse files
authored
Update packaging.md
updating the readme file for installation of apidash using homebrew
1 parent d67ea65 commit 7ee42ae

File tree

1 file changed

+55
-2
lines changed

1 file changed

+55
-2
lines changed

doc/dev_guide/packaging.md

Lines changed: 55 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,61 @@ TODO Instructions
2121
TODO Instructions
2222

2323
## Homebrew
24-
25-
TODO Instructions
24+
# apidash Homebrew Formula Submission
25+
26+
## 1. Prepare Tap Repository
27+
```
28+
# Create Homebrew tap
29+
gh repo create homebrew-tap --public --clone
30+
mkdir -p homebrew-tap/Formula
31+
cd homebrew-tap
32+
```
33+
34+
## 2. Package apidash
35+
```
36+
# Build macOS bundle
37+
flutter build macos
38+
39+
# Create versioned tarball
40+
tar -czvf apidash-v1.0.0.tar.gz \
41+
-C build/macos/Build/Products/Release/ \
42+
Apidash.app
43+
44+
# Generate SHA256 checksum
45+
shasum -a 256 apidash-v1.0.0.tar.gz
46+
```
47+
48+
## 3. Create Formula File
49+
`Formula/apidash.rb`:
50+
```
51+
class Apidash < Formula
52+
desc "Modern API dashboard for developers"
53+
homepage "https://apidash.dev"
54+
url "https://github.com/<user>/<repo>/releases/download/v1.0.0/apidash-v1.0.0.tar.gz"
55+
sha256 "PASTE_YOUR_SHA256_HERE"
56+
57+
def install
58+
prefix.install "Apidash.app"
59+
bin.write_exec_script prefix/"Apidash.app/Contents/MacOS/Apidash"
60+
end
61+
62+
test do
63+
system "#{bin}/Apidash", "--version"
64+
end
65+
end
66+
```
67+
68+
## 4. Local Validation
69+
```
70+
# Check formula syntax
71+
brew audit --strict Formula/apidash.rb
72+
73+
# Test installation
74+
brew install --build-from-source Formula/apidash.rb
75+
76+
# Verify execution
77+
brew test apidash
78+
```
2679

2780
## Chocolatey
2881

0 commit comments

Comments
 (0)