Skip to content

AppImageHub-Submission-Guide.md

Latest commit

 

History

History
317 lines (222 loc) · 7.76 KB

AppImageHub-Submission-Guide.md

File metadata and controls

317 lines (222 loc) · 7.76 KB

AppImageHub Submission Guide

This guide walks through submitting Aquiis Property Management to AppImageHub for improved discoverability.

Prerequisites

  • ✅ v1.0.0 release published on GitHub
  • ✅ AppImage built and tested (230MB, ~2s startup)
  • ✅ Desktop file created (aquiis.desktop)
  • ✅ AppStream metadata created (com.aquiis.propertymanagement.appdata.xml)
  • ⏳ Screenshots needed (4 images)
  • ⏳ Fork appimage.github.io repository
  • ⏳ Submit pull request

Step 1: Capture Screenshots

Launch the application and capture 4 screenshots (see Documentation/Screenshots/README.md for details):

# Launch application
~/Applications/AquiisPropertyManagement-1.0.0.AppImage

# Capture dashboard (primary screenshot)
gnome-screenshot -w -d 2
# Save as: Documentation/Screenshots/dashboard.png

# Navigate to Properties and capture
gnome-screenshot -w -d 2
# Save as: Documentation/Screenshots/property-management.png

# Navigate to Leases and capture
gnome-screenshot -w -d 2
# Save as: Documentation/Screenshots/lease-workflow.png

# Navigate to Invoices and capture
gnome-screenshot -w -d 2
# Save as: Documentation/Screenshots/invoice-tracking.png

Requirements:

  • PNG format
  • 1920x1080 recommended (minimum 752x423)
  • Under 500KB each
  • Show actual features, not promotional graphics

Step 2: Commit Screenshots to Repository

Screenshots must be on GitHub before AppImageHub submission:

cd ~/Source/Aquiis

# Add screenshots
git add Documentation/Screenshots/*.png

# Commit
git commit -m "Add AppImageHub screenshots for v1.0.0 submission"

# Follow normal workflow: feature → development → PR to main

Step 3: Fork AppImageHub Repository

  1. Visit: https://github.com/AppImage/appimage.github.io
  2. Click "Fork" button (top right)
  3. Fork to your GitHub account

Step 4: Clone Your Fork

# Clone your fork
git clone https://github.com/YOUR_USERNAME/appimage.github.io.git ~/appimage.github.io

cd ~/appimage.github.io

# Add upstream remote
git remote add upstream https://github.com/AppImage/appimage.github.io.git

# Fetch latest
git fetch upstream
git checkout master
git merge upstream/master

Step 5: Run Preparation Script

cd ~/Source/Aquiis/4-Aquiis.SimpleStart/Assets
./prepare-appimage-hub-submission.sh

This script will:

  • Create database/Aquiis_Property_Management/ directory
  • Copy desktop file, icon, and AppStream metadata
  • Copy primary screenshot
  • Provide next steps

Step 6: Verify Files

cd ~/appimage.github.io/database/Aquiis_Property_Management
ls -lh

# Should see:
# aquiis.desktop
# aquiis.png (512x512 icon)
# com.aquiis.propertymanagement.appdata.xml
# screenshot.png (dashboard screenshot)

Verify desktop file:

cat aquiis.desktop

Validate AppStream metadata:

appstreamcli validate com.aquiis.propertymanagement.appdata.xml

Step 7: Create Branch and Commit

cd ~/appimage.github.io

# Create branch
git checkout -b add-aquiis-property-management

# Add files
git add database/Aquiis_Property_Management/

# Commit
git commit -m "Add Aquiis Property Management

Aquiis SimpleStart is a property management application for small landlords
managing 1-9 residential rental properties.

Features:
- Property, tenant, and lease management
- Automated invoicing and payment tracking
- Maintenance request tracking
- Property inspections with PDF reports
- Security deposit investment tracking
- Multi-user support with role-based access

Homepage: https://github.com/xnodeoncode/Aquiis
License: MIT
AppImage: https://github.com/xnodeoncode/Aquiis/releases/tag/v1.0.0"

# Push to your fork
git push origin add-aquiis-property-management

Step 8: Create Pull Request

  1. Visit: https://github.com/AppImage/appimage.github.io/compare
  2. Click "compare across forks"
  3. Base fork: AppImage/appimage.github.io, branch: master
  4. Head fork: YOUR_USERNAME/appimage.github.io, branch: add-aquiis-property-management
  5. Click "Create pull request"

PR Title:

Add Aquiis Property Management

PR Description:

## Application Details

**Name:** Aquiis Property Management  
**Category:** Office, Finance  
**License:** MIT  
**Homepage:** https://github.com/xnodeoncode/Aquiis  
**Download:** https://github.com/xnodeoncode/Aquiis/releases/tag/v1.0.0

## Description

Property management software for small landlords managing 1-9 residential rental properties. Provides professional-grade features including:

- Complete tenant lifecycle management (prospect → application → lease)
- Automated rent invoicing and payment tracking
- Maintenance request tracking with vendor management
- Property inspections with comprehensive checklists
- Security deposit investment tracking
- Multi-user support with role-based access control

Built with .NET 10, Blazor Server, and ElectronNET. Standalone desktop application with no server or subscription required.

## Files Included

- ✅ `aquiis.desktop` - Desktop entry file
- ✅ `aquiis.png` - Application icon (512x512)
- ✅ `com.aquiis.propertymanagement.appdata.xml` - AppStream metadata
- ✅ `screenshot.png` - Primary screenshot (dashboard)

## Validation

AppStream metadata validated with `appstreamcli`:

appstreamcli validate com.aquiis.propertymanagement.appdata.xml


## Testing

AppImage tested on:
- RHEL 10 (development platform)
- Performance: ~2 second startup
- Size: 230MB (normal compression)

## Contact

- **GitHub:** @xnodeoncode
- **Email:** cisguru@outlook.com
  1. Click "Create pull request"

Step 9: Respond to Review

AppImageHub maintainers typically review within 1 week. Common feedback:

  • Screenshot quality or content
  • Desktop file formatting
  • AppStream metadata completeness
  • Icon resolution

Be responsive:

  • Check GitHub notifications daily
  • Respond within 24-48 hours
  • Make requested changes promptly

Step 10: Post-Approval

Once merged:

  1. Verify listing: Visit https://appimage.github.io and search for "Aquiis"
  2. Update README: Add AppImageHub badge
  3. Monitor feedback: Watch for user issues on GitHub
  4. Update listing: Submit new PR for version updates

AppImageHub Badges (Post-Approval)

Add to README.md:

[![Get it on AppImageHub](https://img.shields.io/badge/AppImageHub-Aquiis%20Property%20Management-blue.svg)](https://appimage.github.io/Aquiis_Property_Management/)

Maintenance

For future releases:

  1. Update AppStream metadata with new <release> entry
  2. Update screenshots if UI changes significantly
  3. Submit new PR to appimage.github.io with updates
  4. Maintainers prefer: Incremental updates over large changes

Troubleshooting

Validation Errors

# Common issues
appstreamcli validate --explain com.aquiis.propertymanagement.appdata.xml

Screenshot Not Found

Ensure screenshots are:

  • Committed to main branch
  • Accessible via raw GitHub URLs
  • Correct filenames in AppStream metadata

Desktop File Issues

# Validate desktop file
desktop-file-validate aquiis.desktop

Resources

Timeline

  • Screenshots: 30 minutes - 1 hour
  • Fork/Clone: 5 minutes
  • Preparation: 10 minutes (automated script)
  • PR Creation: 15 minutes
  • Review Process: 3-7 days
  • Total: ~1 week from start to approval

Status

  • Screenshots captured and committed
  • appimage.github.io forked
  • Preparation script executed
  • Files verified and validated
  • Pull request created
  • Review feedback addressed
  • Approved and merged
  • Listing verified on AppImageHub