mgmcn / fastcv

Build your personal cv with hugo and display it using github.io. Help the world struggling to find a job to quickly build their cv/resume.

FastCV

A complete beginner's tutorial shows you how to build your personal cv with hugo and display it using github.io.

Environment

For mac user 👇🏻
MacOS Ventura 13.2
Hugo version -> Hugo v0.110.0+extended darwin/arm64
For linux user 👇🏻
Ubuntu 20.04.5 LTS (GNU/Linux 5.4.0-131-generic x86_64)
Hugo version -> Hugo Static Site Generator v0.68.3/extended linux/amd64
For windows user 👇🏻
Windows 11 21H2 22000.376
Hugo version -> Hugo v0.111.0+extended windows/amd64

Get start

Automate the local build process (suggested)

If you want to automate the local build of your cv, execute the following command.

Windows

If you are a windows user, please install chocolatey and git first. See -> how-to-use-chocolatey-choco-to-install-git-on-windows.
Then choose a directory to open git-bash and find build-windows-x86_64.sh of this project that you clone.
Execute the following command to build your cv locally.

# When you execute the command plz remove '$' first.
$ echo "hugo server --source hugoServer/mycv" >> build-windows-x86_64.sh
$ sh build-windows-x86_64.sh

If your git-bash is already configured with ssh access to your github, then you can jump directly to step-create-repository and step-deploy.

MacOS & Linux_Ubuntu

# When you execute the command plz remove '$' first.
$ chmod +x build-macos-arm_64.sh # If you are a linux user please try build-linux-x86_64.sh
$ echo "hugo server --source hugoServer/mycv" >> build-macos-arm_64.sh
$ ./build-macos-arm_64.sh

After executing this build script, please jump directly to step-configure-ssh and step-create-repository. Then jump to step-deploy.

Install Git

For most people who use github, I assume they have git installed correctly. But if you are new to github and don't have git installed, plz check out link.

Install homebrew

Homebrew is a free and open source package management system that simplifies the installation of software on macOS systems.

$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

Install hugo

$ brew install hugo
$ hugo version # Success if version output is available
...

Configure SSH key for github

Adding the ssh key is for our later operations to go on smoothly.

$ cd ~/.ssh # If you don't have this folder, please google for how to generate ssh key.
$ ls
id_rsa		id_rsa.pub ...
$ cat id_rsa.pub # Copy all your output.
.
.
.

Access your github account settings page. (ps:If you are already logged in then just click -> link) Find option called SSH key and GPG keys. Create SSH key like 👇🏻. Put the text of the id_rsa.pub you copied into the place of the key below.

Create a repository for your cv

Notice: repository name should be like your_account_name.github.io. When you visit your github homepage, the string at the end of your link is your_account_name. For me the link is "https://github.com/MGMCN". So my_account_name is "MGMCN".

Build our cv locally

$ mkdir hugoServer
$ hugo new site hugoServer/mycv
$ git clone https://gitlab.com/mertbakir/resume-a4.git hugoServer/mycv/themes/resume-a4
$ cp hugoServer/mycv/themes/resume-a4/config.yaml hugoServer/mycv/
$ cp -r hugoServer/mycv/themes/resume-a4/exampleSite/data hugoServer/mycv/
$ rm hugoServer/mycv/config.toml # using config.yaml as our config file
$ hugo server --source hugoServer/mycv --disableFastRender # Now you can check your hugo-server is working locally by access http://localhost:1313/ .

Deploy our cv to github.io

$ hugo --source hugoServer/mycv -D
$ cd hugoServer/mycv/public
$ git init
$ git remote add origin [email protected]:your_account_name/your_account_name.github.io.git
$ git pull origin main
$ git checkout main # Make sure you are on the main branch.
$ git add .
$ git commit -m "first commit"
$ git push -u origin main
...
# Now you can view your cv by visiting your_account_name.github.io

Workflow to edit this cv

Edit these two files. See what has changed by using the local hugo server.

$ ls # Now back to our root directory.
.
├── archetypes
├── config.yaml # 👈🏻 This is a configuration file where you can configure.
├── content
├── data # 👈🏻 Your cv details are all in this folder.
│   ├── education.yaml 
│   ├── experience.yaml
│   ├── features.yaml
│   ├── projects.yaml
│   └── publications.yaml
├── layouts
├── public
├── resources
├── static
└── themes

When you have edited any one or more of these two files and you want to change the content displayed on github.io.

$ ls # First back to our root directory. 
.
├── archetypes
├── config.yaml
├── content
├── data
├── layouts
├── public
├── resources
├── static
└── themes
# Then run 👇🏻
$ hugo -D
$ cd public
$ git checkout main
$ git add .
$ git commit -m "cv updated"
$ git push
# Now you can view your changes by visiting your_account_name.github.io

Hugo Theme we use

Thanks to resume-a4. If you need more details about Hugo Themes, please check out HugoThemes. ( ps: To make sure that the resume theme is not inaccessible, I have also added an archive file. )

fastcv's Issues

Maintenance Issue

Hi MGMCN,
FastCV is a very good idea, but I think the current version is not good to maintain and extend as the environment changing. So I can contribute a Dockerfile to help control the requirements and environment of this project, so that this project can be maintained and run for a long time.
Regards

Git Branch Issue

When I pulled from Github, I found I was on master branch not main, which makes Git does not work well. To fix it, I had to switch to main branch by 'checkout', then I was able to work correctly on Git.

Issue of Documents

What if I got no Git on my PC?