Operations Runbook

🛠️ Quick Resume App – Operations Runbook

📌 Overview

This runbook provides step-by-step instructions for setting up, maintaining, debugging, and recovering the Quick Resume App Flutter application deployed via GitHub Pages and distributed as a mobile application.

• Project Type: Flutter-based Cross-platform App
• Tech Stack: Flutter, Dart
• Storage: Cloud Storage & Local Cache
• Deployment: GitHub Pages (Web) & App Stores (Mobile)
• CI/CD: GitHub Actions
• Repository: https://github.com/IreshikaSewwandi/quick_resume_app.git

⚙️ 1. Development Environment Setup

Step	Task	Command / Action
1	Install Flutter SDK	Follow Flutter installation guide
2	Clone the repository	git clone https://github.com/IreshikaSewwandi/quick_resume_app.git
3	Navigate to project directory	cd quick_resume_app
4	Get dependencies	flutter pub get
5	Run development version	flutter run
6	Make changes and commit	git add . && git commit -m "your message"
7	Push to appropriate branch	git push origin <branch-name>

🚀 2. Deployment Instructions

Web Deployment (GitHub Pages)

Deployment is automatically handled via GitHub Actions.

🔄 CI/CD Flow:

• Pull requests to main trigger the development deployment workflow
• Merges to main trigger the production deployment workflow using blue-green strategy
• The workflow builds Flutter web and publishes to GitHub Pages

✅ No manual deployment required for web version.

To check:

• Go to Actions tab → verify green check ✅
• Visit deployed site: https://ireshikasewwandi.github.io/quick_resume_app/

🧪3. Manual Testing Checklist

• Create new resume with each template
• Edit and save resume data
• Export as PDF and DOCX
• Test responsive layout on various screen sizes
• Verify offline functionality

🧯 4. Debugging Steps

Issue	Solution
App crashing at startup	Check Flutter version compatibility with flutter doctor
Cloud sync not working	Verify network connectivity and authentication status
PDF export failing	Check console logs; ensure PDF plugin is properly initialized
GitHub Actions failed	Go to Actions tab → Click the failed job → Review logs
Templates not loading	Verify asset paths in pubspec.yaml and template service
Blue-green deployment stuck	Check deployment logs; manually switch traffic if necessary

🔄 5. Backup & Recovery

Local Recovery (Development)

1. Source Code:

• All code is versioned in GitHub
• Use git checkout [commit-hash] to restore specific version

2. Environment Configuration:

• Environment variables are stored in secure GitHub Secrets
• CI/CD configuration in .github/workflows/

📦 6. Project Structure

👨‍🔧 7. Maintenance Tasks

• Use only the main branch to commit production-ready code
• Monitor storage usage and API call quotas
• Review GitHub Actions logs after each push