GitHub Travel Sync Template 🚀

A development-safe automated synchronization template for keeping GitHub repositories in sync between your development machine, travel server, and GitHub - regardless of network location.

🎯 Use this template to create your own customized sync solution in minutes!

🌟 Why This Template?

🛡️ Safety First: Never overwrites uncommitted work or active development
🌐 Network Agnostic: Works on university, home, mobile, VPN networks automatically
⚡ One-Click Setup: Automated installation scripts for all dependencies
🔧 Fully Customizable: Easy configuration for your repositories and network
📊 Professional Monitoring: Comprehensive logging and status reporting
🚀 Production Ready: Used in real development workflows

🏗️ Architecture Overview

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Development   │    │     GitHub      │    │ Travel Server   │
│    Machine      │◄──►│   Repositories  │◄──►│  (Any Linux)    │
│                 │    │                 │    │                 │
│ Windows/macOS/  │    │  Source of      │    │ Raspberry Pi    │
│     Linux       │    │  Truth          │    │ ZimaBoard, etc. │
└─────────────────┘    └─────────────────┘    └─────────────────┘
         ▲                        ▲                        ▲
         │                        │                        │
    Auto-discovery            Safety checks            Systemd
    Network patterns          Before every sync        automation

🚀 Quick Start (5 Minutes)

1. Create Your Repository

# Use this template to create your own repository
# Click "Use this template" button on GitHub, or:
gh repo create my-sync-solution --template LReyes21/github-travel-sync-template
cd my-sync-solution

2. Install Dependencies

Choose your platform and run the appropriate script:

Windows (PowerShell as Administrator)

.\setup\install-windows.ps1

macOS

./setup/install-macos.sh

Linux (Development Machine)

./setup/install-linux-desktop.sh

Linux (Server/Travel Device)

./setup/install-linux-server.sh

3. Configure Your Setup

# Copy and edit configuration templates
cp config/laptop-config.example.ps1 config/laptop-config.ps1
cp config/server-config.example.sh config/server-config.sh

# Edit with your GitHub username, repositories, and server details
nano config/laptop-config.ps1      # Windows/macOS users
nano config/server-config.sh       # Server configuration

4. Deploy and Test

# Install on your development machine
./scripts/auto-sync-safe.ps1 -Install    # Windows
./scripts/auto-sync-safe.sh -install     # Linux/macOS

# Install on your server
scp -r . user@yourserver:~/sync-setup/
ssh user@yourserver "cd sync-setup && sudo ./setup/install-linux-server.sh"

📋 Requirements & Dependencies

Automatic Installation Scripts

This template includes automated setup scripts that install all required dependencies:

Windows Requirements

PowerShell 5.1+ (included in Windows 10+)
Git for Windows
GitHub CLI
OpenSSH Client (Windows 10+)

Auto-install script: setup/install-windows.ps1

macOS Requirements

Homebrew package manager
Git
GitHub CLI
SSH client (built-in)

Auto-install script: setup/install-macos.sh

Linux Desktop Requirements

Bash 4.0+
Git
GitHub CLI
SSH client
curl/wget

Auto-install script: setup/install-linux-desktop.sh

Linux Server Requirements

Bash 4.0+
Git
GitHub CLI
SSH server/client
systemd (for automation)

Auto-install script: setup/install-linux-server.sh

Manual Installation (if needed)

Click to expand manual installation instructions

Windows Manual Setup

# Install Git for Windows
winget install Git.Git

# Install GitHub CLI
winget install GitHub.cli

# Verify PowerShell version (should be 5.1+)
$PSVersionTable.PSVersion

macOS Manual Setup

# Install Homebrew if not present
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install dependencies
brew install git gh

Linux Manual Setup

# Ubuntu/Debian
sudo apt update
sudo apt install git curl

# Install GitHub CLI
curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
sudo apt update
sudo apt install gh

# CentOS/RHEL/Fedora
sudo dnf install git gh

📁 Template Structure

github-travel-sync-template/
├── README.md                          # This file
├── LICENSE                            # MIT License
├── CHANGELOG.md                       # Version history
│
├── setup/                             # Automated installation scripts
│   ├── install-windows.ps1           # Windows dependency installer
│   ├── install-macos.sh              # macOS dependency installer  
│   ├── install-linux-desktop.sh      # Linux desktop installer
│   ├── install-linux-server.sh       # Linux server installer
│   └── verify-setup.ps1              # Setup verification script
│
├── scripts/                           # Main sync scripts
│   ├── auto-sync-safe.ps1            # Windows/PowerShell client
│   ├── auto-sync-safe.sh             # Linux/macOS client
│   ├── server-sync-safe.sh           # Server-side sync script
│   └── network-discovery.ps1         # Network discovery utilities
│
├── config/                           # Configuration templates
│   ├── laptop-config.example.ps1    # Client configuration template
│   ├── server-config.example.sh     # Server configuration template
│   ├── repositories.example.txt     # Repository list template
│   └── ssh-config.example           # SSH configuration example
│
├── systemd/                          # Linux service definitions
│   ├── github-sync.service          # Systemd service
│   └── github-sync.timer            # Systemd timer
│
├── docs/                             # Documentation
│   ├── SETUP-GUIDE.md               # Step-by-step setup
│   ├── TROUBLESHOOTING.md           # Common issues
│   ├── CUSTOMIZATION.md             # Advanced customization
│   └── EXAMPLES.md                  # Real-world examples
│
└── examples/                         # Example configurations
    ├── university-setup/             # University network example
    ├── home-office/                  # Home office setup
    └── mobile-developer/             # Mobile developer setup

🛡️ Safety Features

What Gets Protected

✅ Uncommitted changes - Modified files not yet committed
✅ Untracked files - New files not added to Git
✅ Recent activity - Files modified in configurable time window
✅ Merge operations - Active merge conflicts or rebases
✅ Stashed changes - Work saved in Git stash
✅ Branch state - Prevents sync during branch operations

Smart Detection

🔍 Pre-sync analysis of every repository
📊 Detailed status reporting on what's safe vs. risky
⚠️ Clear warnings when sync is skipped
🚨 Force override available when needed
📝 Comprehensive logging of all operations

🔧 Customization

Repository Configuration

# config/laptop-config.ps1
$GitHubUser = "YourUsername"
$Repos = @("repo1", "repo2", "repo3")
$ServerPatterns = @("server.local", "192.168.1.100")

Network Discovery

# Add your network patterns
$ServerPatterns = @(
    "myserver.local",           # mDNS/Bonjour
    "myserver.university.edu",  # University network
    "myserver.company.com",     # Work VPN
    "192.168.1.100",           # Home network
    "10.0.0.100"               # Custom network
)

Safety Settings

$SafetySettings = @{
    RecentActivityThresholdMinutes = 30  # Adjust sensitivity
    ForceOverride = $false               # Allow/disallow force sync
    BackupBeforeSync = $true             # Enable automatic backups
}

📊 Example Use Cases

🎓 University Researcher

Development Machine: University lab workstation
Travel Server: Raspberry Pi in dorm room
Sync: Research code, papers, and data analysis scripts
Networks: Campus WiFi, dorm ethernet, library connections

💼 Remote Developer

Development Machine: Home office laptop
Travel Server: ZimaBoard portable server
Sync: Client projects, personal tools, configuration files
Networks: Home WiFi, coffee shop hotspots, client offices

🚗 Digital Nomad

Development Machine: MacBook for development
Travel Server: Mini PC in RV/hotel
Sync: Portfolio projects, client work, backup repositories
Networks: Mobile hotspot, campground WiFi, coworking spaces

🔗 Integration Examples

VS Code Integration

// .vscode/tasks.json
{
    "label": "Sync Repositories",
    "type": "shell",
    "command": "./scripts/auto-sync-safe.ps1",
    "args": ["-Sync"],
    "group": "build"
}

Git Hooks

#!/bin/bash
# .git/hooks/pre-push
./scripts/auto-sync-safe.sh --pre-push-check

Cron Alternative (Linux)

# For systems without systemd
*/120 * * * * /path/to/scripts/auto-sync-safe.sh --cron

🧪 Testing Your Setup

Verify Installation

./setup/verify-setup.ps1          # Windows
./setup/verify-setup.sh           # Linux/macOS

Test Network Discovery

./scripts/network-discovery.ps1 --test

Dry Run Sync

./scripts/auto-sync-safe.ps1 --dry-run

🤝 Contributing

This is a template repository! Contributions help everyone:

Fork this template
Create feature branch (git checkout -b feature/amazing-feature)
Commit changes (git commit -m 'Add amazing feature')
Push to branch (git push origin feature/amazing-feature)
Open Pull Request

Areas for Contribution

🔧 Additional platform support
📱 Mobile device integration
🔒 Enhanced security features
📊 Monitoring and alerting
🎨 UI/dashboard development

📞 Support & Community

🐛 Issues: GitHub Issues
💬 Discussions: GitHub Discussions
📖 Documentation: docs/
📧 Contact: Create an issue for support requests

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Inspired by the need for reliable development synchronization across diverse network environments
Built for developers who work from anywhere with any device
Designed with safety and simplicity as core principles

🚀 Ready to Get Started?

Use this template to create your repository
Run the setup script for your platform
Configure your repositories and server details
Deploy and enjoy seamless synchronization everywhere!

Made with ❤️ for developers who code everywhere.

Name		Name	Last commit message	Last commit date
Latest commit History 1 Commit
scripts		scripts
setup		setup
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md

License

LReyes21/github-travel-sync-template

Folders and files

Latest commit

History

Repository files navigation