Skip to content

Technical Design Document (TDD)

E.M.I.S.Premarathna edited this page Apr 22, 2025 · 6 revisions

⚙️ Technical Design Document (TDD)

📌 Overview

This document outlines the technical architecture, design choices, and development workflow for the Quick Resume App project. It is a cross-platform mobile application built using Next.js with cloud storage integration. The application is deployed to both mobile platforms and the web via GitHub Pages using a CI/CD pipeline.

🏗️ Architecture Overview

image

📁 Folder Structure

image

🔧 Technology Stack

Layer Technology
Frontend Next.js
State Management local Storage
PDF Generation pdf package
DOCX Generation docx package
Deployment GitHub Pages
CI/CD GitHub Actions

🔄 Data Flow

User Authentication Flow

  • User login/signup via email or social providers

Resume Creation Flow

  • Template selection
  • Data input through form interfaces
  • Real-time preview generation
  • Auto-save functionality to prevent data loss

Export Flow

  • Format selection (PDF/DOCX)
  • Document generation and preview
  • download DOCX or PDF

🛠️ Development Workflow

  • Feature planning in GitHub Projects
  • Branch creation for feature development
  • Pull Request with code review requirements
  • Automated testing in CI pipeline
  • Deployment to development environment

Clone this wiki locally