{"id":28401574,"url":"https://github.com/korenko-git/resume","last_synced_at":"2026-03-04T07:30:54.560Z","repository":{"id":290821607,"uuid":"975664015","full_name":"korenko-git/resume","owner":"korenko-git","description":"A modern, serverless resume editor built with Next.js that generates both interactive web resumes and ATS-friendly PDFs. Edit content through a user-friendly interface and deploy via GitHub Pages.","archived":false,"fork":false,"pushed_at":"2025-06-12T09:31:45.000Z","size":1703,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-23T11:13:57.379Z","etag":null,"topics":["accessibility","ats-friendly","github-actions","github-pages","jest","nextjs","pdf-generator","react","resume-builder","serverless","shadcn-ui","tailwindcss","testing-library","typescript"],"latest_commit_sha":null,"homepage":"https://korenko-git.github.io/resume/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/korenko-git.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-30T17:29:34.000Z","updated_at":"2025-06-12T09:31:49.000Z","dependencies_parsed_at":"2025-04-30T18:54:26.899Z","dependency_job_id":"8359b110-d7ac-4c69-92e5-1be60e8612a8","html_url":"https://github.com/korenko-git/resume","commit_stats":null,"previous_names":["korenko-git/resume"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/korenko-git/resume","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/korenko-git%2Fresume","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/korenko-git%2Fresume/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/korenko-git%2Fresume/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/korenko-git%2Fresume/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/korenko-git","download_url":"https://codeload.github.com/korenko-git/resume/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/korenko-git%2Fresume/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30075427,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T05:31:57.858Z","status":"ssl_error","status_checked_at":"2026-03-04T05:31:38.462Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accessibility","ats-friendly","github-actions","github-pages","jest","nextjs","pdf-generator","react","resume-builder","serverless","shadcn-ui","tailwindcss","testing-library","typescript"],"created_at":"2025-06-01T13:00:21.355Z","updated_at":"2026-03-04T07:30:54.381Z","avatar_url":"https://github.com/korenko-git.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📟 Resume Editor — GitHub-Powered \u0026 Serverless\n\nA fully static, GitHub-powered resume website builder. This project allows you to create, edit, and manage your resume content through a web interface, storing data in JSON files and leveraging GitHub Actions for updates and deployment.\n\n## ✨ Features\n\n- **Static Site Generation:** Built with Next.js for a fast, secure, and easily deployable static website.\n- **Data-Driven:** Resume content (About, Experience, Education, Projects, Certifications, Organizations) is managed via JSON files in `src/data`.\n- **In-Browser Editor:** A dedicated `/editor` route provides a user-friendly interface to modify resume content. Drafts are saved locally using `localStorage`.\n- **Live Preview:** The main `/` route displays the formatted resume based on the current data.\n- **ATS-Friendly PDF Export:** Includes a script (`scripts/generate-ats-resume.ts`) to generate a simplified Markdown and PDF version suitable for Applicant Tracking Systems (ATS), outputting to the `public/` directory.\n- **GitHub Workflow:** Edits made in the editor can be downloaded as a `.zip` archive. Submitting this archive via a GitHub Pull Request triggers GitHub Actions to update the content, rebuild the site, and regenerate the PDF.\n\n## 🛠️ Tech Stack\n\n- **Framework:** [Next.js](https://nextjs.org/) (v15+) with [React](https://reactjs.org/) (v19+)\n- **Language:** TypeScript\n- **Styling:** [Tailwind CSS](https://tailwindcss.com/) (v4) \u0026 [shadcn/ui](https://ui.shadcn.com/)\n- **State Management:** React Context API (`ResumeContext.tsx`)\n- **UI Enhancements:**\n  - [React Joyride](https://docs.react-joyride.com/) for the welcome tour.\n- **Data Storage:** JSON files \u0026 Browser `localStorage`\n- **PDF Generation:** [markdown-it](https://github.com/markdown-it/markdown-it) \u0026 [Puppeteer](https://pptr.dev/)\n- **Testing:** [Jest](https://jestjs.io/) \u0026 [React Testing Library](https://testing-library.com/)\n\n## 🚀 Getting Started\n\n1.  **Clone the repository:**\n    ```bash\n    git clone \u003cyour-repository-url\u003e\n    cd resume\n    ```\n2.  **Install dependencies:**\n    ```bash\n    npm install\n    ```\n3.  **Run the development server:**\n    ```bash\n    npm run dev\n    ```\n    Open [http://localhost:3000](http://localhost:3000) to view the main resume page.\n    Open [http://localhost:3000/editor](http://localhost:3000/editor) to access the editor.\n\n## 📜 Available Scripts\n\n- `npm run dev`: Starts the Next.js development server with Turbopack for faster refresh times and improved development experience. Access the site at http://localhost:3000.\n- `npm run build`: Builds the application for production, generating optimized static files ready for deployment.\n- `npm run start`: Starts the production server using the built files. Requires running `npm run build` first.\n- `npm run lint`: Lints the codebase using ESLint to identify and fix code style issues and potential errors in JavaScript, JSX, TypeScript, and TSX files.\n- `npm run typecheck`: Checks TypeScript types across the project without emitting compiled files, ensuring type safety.\n- `npm run test`: Runs Jest tests to verify code functionality and prevent regressions.\n- `npm run test:watch`: Runs Jest tests in watch mode, automatically re-running tests when files change.\n- `npm run test:coverage`: Runs Jest tests and generates a coverage report to identify untested code.\n- `npm run pdf`: Generates an ATS-friendly PDF resume using the scripts in `scripts/generate-ats-md.ts` and `scripts/generate-ats-pdf.ts`. The output is saved to `public/asts/cv-ats.pdf`.\n- `npm run og`: Generates an OpenGraph image for social media sharing using the script in `scripts/generate-og-image.ts`. The output is saved to `public/og/resume-og.png`.\n\n## 📁 Project Structure\n\n- `.github/workflows/`: GitHub Actions workflows for CI/CD\n  - `apply-updates.yml`: Processes ZIP files in the updates directory\n  - `build-static.yml`: Builds and deploys the static site to GitHub Pages\n  - `generate-ats-cv.yml`: Generates ATS-friendly resume versions\n  - `generate-og-image.yml`: Creates OpenGraph image for social sharing\n  - `yearly-update.yml`: Automatically triggers rebuild on January 1st\n- `public/`: Static assets and generated files\n- `scripts/`: Utility scripts for PDF generation\n- `src/`: Source code\n  - `app/`: Next.js app router components\n  - `components/`: Reusable UI components\n  - `contexts/`: React context providers\n  - `data/`: JSON data files for resume content\n  - `hooks/`: Custom React hooks\n  - `lib/`: Utility functions\n  - `services/`: Business logic and data storage services\n  - `types/`: TypeScript type definitions\n- `updates/`: Directory for ZIP files containing resume updates\n\n## ✍️ Editing Workflow\n\n1.  Navigate to the `/editor` page on your deployed site or local development server.\n2.  Make desired changes to the resume sections using the inline editing forms. Upload new images if needed.\n3.  Click the **\"Download Changes\"** button to get a `.zip` archive containing the updated JSON data and any new images.\n4.  Commit and push this `.zip` file to the `/updates` directory in your GitHub repository (typically via a Pull Request).\n5.  GitHub Actions will automatically:\n    - Detect the new `.zip` file\n    - Extract its contents\n    - Update the corresponding JSON files and images\n    - Delete the processed `.zip`\n    - Rebuild the Next.js site\n    - Generate ATS-friendly versions (Markdown and PDF)\n    - Deploy to GitHub Pages\n\n## 🤖 GitHub Actions Workflows\n\nThis project uses several GitHub Actions workflows to automate the resume update and deployment process:\n\n### Apply Resume Updates (`apply-updates.yml`)\n\n- **Trigger**: Push to master, pull requests, or manual dispatch\n- **Purpose**: Processes ZIP files uploaded to the `/updates` directory\n- **Actions**:\n  - Extracts JSON data and images from ZIP files\n  - Updates the corresponding files in the repository\n  - Validates JSON files for correctness\n  - Removes processed ZIP files\n  - Commits and pushes changes\n\n### Build Static Next.js (`build-static.yml`)\n\n- **Trigger**: After Apply Resume Updates workflow completes, or manual dispatch\n- **Purpose**: Builds and deploys the static Next.js site to GitHub Pages\n- **Actions**:\n  - Runs linting, type checking, and tests\n  - Triggers ATS CV generation\n  - Configures base path for GitHub Pages deployment\n  - Builds the static site with Next.js\n  - Deploys to GitHub Pages\n\n### Generate ATS CV (`generate-ats-cv.yml`)\n\n- **Trigger**: Called by other workflows or manual dispatch\n- **Purpose**: Creates ATS-friendly versions of the resume\n- **Actions**:\n  - Checks for changes in JSON data files\n  - Generates Markdown version of the resume\n  - Creates PDF version\n  - Commits and pushes the generated files\n\n### Generate OG Image (`generate-og-image.yml`)\n\n- **Trigger**: Called by other workflows or manual dispatch\n- **Purpose**: Creates OpenGraph image for social media sharing\n- **Actions**:\n  - Checks for changes in JSON data files\n  - Generates a PNG image using Puppeteer\n  - Commits and pushes the generated image\n\n### Yearly Date Update (`yearly-update.yml`)\n\n- **Trigger**: Scheduled to run at 00:05 on January 1st, or manual dispatch\n- **Purpose**: Ensures the resume is rebuilt at the start of each year to update relative dates\n- **Actions**:\n  - Triggers the Build Static workflow\n\n## 📄 License\n\n[MIT License](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkorenko-git%2Fresume","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkorenko-git%2Fresume","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkorenko-git%2Fresume/lists"}