remiai3/Rana_Resume_Builder

Rana Resume Builder - ATS Sync Edition

A powerful, ATS-optimized resume builder built with React and Vite. Designed to generate 100% parse-friendly .docx files.

🚀 Features

• 100% ATS Parsing: Uses industry-standard layouts (Jake's Resume / Deedy) ensuring correct "Work Experience" and "Education" detection.
• Smart DOCX Gen: Generates real Word documents with tab-stops (no tables!) for maximum compatibility.
• Premium UI: Smooth entry animations (fadeIn, slideUp), glass-morphism effects, and a responsive editor.
• ATS Checks: Real-time Word Count and Pronoun detection (active voice enforcer).
• Privacy Focused: Runs entirely in your browser. No data sent to any server.

🛠️ Tech Stack

• Frontend: React.js, Vite
• Styling: Vanilla CSS (Standard Variables + Animations)
• Logic: docx library for file generation, file-saver for download.

📦 How to Deploy to GitHub Pages (Free Tier)

This project is pre-configured for GitHub Pages.

Step 1: Push code to GitHub

1. Create a new repository on GitHub (e.g., resume-builder).
2. Run these commands in your terminal:

   git init
   git add .
   git commit -m "Initial commit"
   git branch -M main
   git remote add origin https://github.com/YOUR_USERNAME/resume-builder.git
   git push -u origin main
   

Step 2: Enable GitHub Pages

1. Go to your repository Settings > Pages.
2. Under Build and deployment, select Source -> GitHub Actions.
3. Alternatively (simpler):
   • Run npm run build locally.
   • This creates a dist folder.
   • You can push this dist folder to a gh-pages branch, OR use a simple Action.

Recommended: Use gh-pages package (Easiest)

1. In your terminal, install the deployer:

   npm install gh-pages --save-dev
   

2. Add this script to your package.json under "scripts":

   "predeploy": "npm run build",
   "deploy": "gh-pages -d dist"
   

3. Deploy!

   npm run deploy
   

4. Your app will be live at https://YOUR_USERNAME.github.io/resume-builder/

📄 License

MIT License

Copyright (c) 2026

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.