resumake

README

Resumake

Programmatic Resume Generator

Usage

Using Docker

• edit resume.yml file
• install Docker (at least runtime engine)
• pull the image: docker pull cybardev/resumake
• run resumake: docker run -d --name resumake -p 80:80 cybardev/resumake
• open browser and navigate to localhost
• upload edited resume.yml
• click the Create Resume button
• download generated PDF
• shutdown the Docker container when done

Using the Web App

PS: recommended to use Docker to avoid rate limits

• edit resume.yml file
• go to resumake.cybar.dev
• upload edited resume.yml
• click the Create Resume button
• download generated PDF

Using GitHub Actions

PS: recommended to use Docker to avoid rate limits

Automatically generate your resume and publish it as a website:

• fork this repo
• navigate to your fork
• edit resume.yml file
• edit the resume_png link in this readme to the correct png file
• push changes to your fork

Running Locally

PS: recommended to use Docker on Windows

Dependencies

• go: v1.23.2
• weasyprint

Manual

• edit resume.yml file
• Download the archive file from the Releases page: resumake-{os}-{arch}.zip
  • PS: Make sure to choose the archive corresponding to your OS and architecture
• extract the archive
• cd into the extracted directory
• run the executable (may need to chmod or make it executable otherwise)
• open browser and navigate to localhost
• upload edited resume.yml
• click the Create Resume button
• download generated PDF

Install Go Package

Link to package: pkg.go.dev/github.com/cybardev/resumake/v4

• Run the following command:

  go install github.com/cybardev/resumake/v4@latest
  

• Ensure $GOPATH/bin is added to $PATH. An easy way is to add this line to ~/.profile:

  export PATH="$(go env GOPATH)/bin:$PATH"
  

[!IMPORTANT] The pkg.go.dev registry may have an outdated version. If you encounter bugs or feature disparity, please replace latest after @ with main, e.g. github.com/cybardev/resumake/v4@main, OR try the Manual installation method for the latest updates.

Build from Source

• edit resume.yml file
• run the following commands in project directory:
  • go get .
  • go build
  • ./resumake
• open browser and navigate to localhost
• upload edited resume.yml
• click the Create Resume button
• download generated PDF

Extras

• check Actions tab of your fork for workflow run details
• configure custom domain (if desired) from Settings > Pages
• edit resources/template.go.tmpl to change order of sections or show/hide sections in resume

Sample Output