flutter/apidash
1
0
Fork 0
mirror of https://github.com/foss42/apidash.git synced 2025-06-18 12:28:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update packaging.md

Browse Source
This commit is contained in:
Ashita Prasad
2025-02-12 20:20:35 +05:30
committed by GitHub
parent 60e7c86aaf
commit 5638511a32
1 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
doc/dev_guide/packaging.md
View File

@ -21,9 +21,11 @@ TODO Instructions
TODO Instructions TODO Instructions
## Homebrew ## Homebrew
# apidash Homebrew Formula Submission
## 1. Prepare Tap Repository Homebrew Formula Submission
### 1. Prepare Tap Repository
``` ```
# Create Homebrew tap # Create Homebrew tap
gh repo create homebrew-tap --public --clone gh repo create homebrew-tap --public --clone
@ -31,7 +33,8 @@ mkdir -p homebrew-tap/Formula
cd homebrew-tap cd homebrew-tap
``` ```
## 2. Package apidash ### 2. Package apidash
``` ```
# Build macOS bundle # Build macOS bundle
flutter build macos flutter build macos
@ -45,8 +48,10 @@ tar -czvf apidash-v1.0.0.tar.gz \
shasum -a 256 apidash-v1.0.0.tar.gz shasum -a 256 apidash-v1.0.0.tar.gz
``` ```
## 3. Create Formula File ### 3. Create Formula File
`Formula/apidash.rb`: `Formula/apidash.rb`:
``` ```
class Apidash < Formula class Apidash < Formula
desc "Modern API dashboard for developers" desc "Modern API dashboard for developers"
@ -65,7 +70,8 @@ class Apidash < Formula
end end
``` ```
## 4. Local Validation ### 4. Local Validation
``` ```
# Check formula syntax # Check formula syntax
brew audit --strict Formula/apidash.rb brew audit --strict Formula/apidash.rb
@ -76,7 +82,9 @@ brew install --build-from-source Formula/apidash.rb
# Verify execution # Verify execution
brew test apidash brew test apidash
``` ```
## 5. Custom Tap Submission
### 5. Custom Tap Submission
``` ```
# Commit formula to your tap repo # Commit formula to your tap repo
git add Formula/Apidash.rb git add Formula/Apidash.rb
@ -86,11 +94,12 @@ git push
# Create release for tarball # Create release for tarball
gh release create v1.0.0 apidash-v1.0.0.tar.gz gh release create v1.0.0 apidash-v1.0.0.tar.gz
``` ```
## 6. Installation
### 6. Installation
``` ```
brew tap homebrew-tap/Formula brew tap homebrew-tap/Formula
brew install apidash brew install apidash
``` ```
## Chocolatey ## Chocolatey