An open API service indexing awesome lists of open source software.

https://github.com/cybardev/resumake

Generate resume using data representation objects
https://github.com/cybardev/resumake

resume resume-builder resume-website

Last synced: 3 months ago
JSON representation

Generate resume using data representation objects

Awesome Lists containing this project

README

          

# Resumake

## Programmatic Resume Generator

resumake logoresumake banner

### Usage

#### Using Render

[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/cybardev/resumake)

#### Using Docker

- edit [`resume.yml`](./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](http://localhost:80)
- upload edited [`resume.yml`](./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](#using-docker) to avoid rate limits

- edit [`resume.yml`](./resume.yml) file
- go to [resumake.cybar.dev](https://resumake.cybar.dev)
- upload edited [`resume.yml`](./resume.yml)
- click the Create Resume button
- download generated PDF

#### Using GitHub Actions

**PS**: recommended to use [Docker](#using-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`](./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](#using-docker) on Windows

##### Dependencies

- `go`: `v1.23.2`
- `weasyprint`

##### Manual

- edit [`resume.yml`](./resume.yml) file
- Download the archive file from the Releases page: [resumake-{os}-{arch}.zip][release]
- **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](http://localhost:80)
- upload edited [`resume.yml`](./resume.yml)
- click the Create Resume button
- download generated PDF

##### Install Go Package

> **Link to package**: [pkg.go.dev/github.com/cybardev/resumake/v6][gopkg]

- Run the following command:

```sh
go install github.com/cybardev/resumake/v6@latest
```

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

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

> [!IMPORTANT]
> The [pkg.go.dev][gopkg] 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/v6@main`, **OR** try the [Manual installation](#manual) method for the latest updates.

##### Build from Source

- edit [`resume.yml`](./resume.yml) file
- run the following commands in project directory:
- `go get .`
- `go build`
- `./resumake`
- open browser and navigate to [localhost](http://localhost:80)
- upload edited [`resume.yml`](./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`][template] to change order of sections or show/hide sections in resume

### Sample Output

[![resume][resume_png]][resume_pdf]

[template]: ./resources/template.go.tmpl "Resume Template"
[resume_png]: https://raw.githubusercontent.com/cybardev/resumake/main/static/assets/Resume_Sheikh_Saad_Abdullah.png "Resume - Sheikh Saad Abdullah"
[resume_pdf]: https://resume.cybar.dev "Resume - Sheikh Saad Abdullah"
[gopkg]: https://pkg.go.dev/github.com/cybardev/resumake/v6
[release]: https://github.com/cybardev/resumake/releases/