Overleaf Resume Sync

Start by cloning the official project repository to your local machine:

This will include the backend, extension code, and GitHub Actions workflow already configured.

Once you’ve cloned the repository to your local machine, follow these steps to load the Chrome extension manually:

1. Open Chrome and go to chrome://extensions/
2. In the top-right corner, toggle on Developer mode
3. Click on the “Load unpacked” button
4. Select the extension folder from the cloned repository (not the root folder)
5. The extension should now appear in your Chrome toolbar
6. Optional: Right-click the extension icon and click “Pin” to keep it visible
7. You can also assign a shortcut from the chrome://extensions/shortcuts page

This project uses a Docker-based backend to sync Overleaf with GitHub. You can deploy it on:

• Render
• Fly.io
• Any Docker-compatible hosting service

Required environment variables during deployment:

• GITHUB_USERNAME – your GitHub username
• GITHUB_REPO – target repository name
• GITHUB_TOKEN – your personal access token (see next step)

docker build -t resume-sync .
docker run -it --rm -p 5000:5000 \
  -e GITHUB_USERNAME=your_username \
  -e GITHUB_REPO=your_repo \
  -e GITHUB_TOKEN=your_token \
  resume-sync
          

This token is used by the backend server to push updates to your GitHub repository.

1. Go to GitHub Developer Settings
2. Click "Generate new token (classic)" or create a fine-grained token
3. Set an expiration date if desired
4. Enable the following repo permissions (both read and write):
   • actions
   • code
   • commit statuses
5. Copy the token and use it as GITHUB_TOKEN in your deployment

Configure GitHub Pages to serve your generated resume.pdf file:

1. Go to your GitHub repository → Settings
2. Scroll to the Pages section
3. Under Source, choose GitHub Actions or root of main branch
4. Save the settings
5. Your resume will be available at:
   https://your-username.github.io/your-repo-name/resume.pdf

Once everything is set up, it's time to sync!

1. Open your Overleaf project in your browser
2. Click the extension icon
3. Click "Sync Resume to GitHub"
4. Wait for GitHub Actions to build your PDF
5. Open your public resume URL to check the result