Skip to content

vamshikr/startbootstrap-resume

 
 

Repository files navigation

Generate Resume for Github Pages using Bootstrap Resume Template

This is my attempt to help you generate a personal web page like https://startbootstrap.com/previews/resume/ for yourselves and host it on https://pages.github.io/ for free.

I have forked https://github.com/BlackrockDigital/startbootstrap-resume and using it as the base, so I am retaining their license.

For your personal information, the data from your LinkedIn profile is used. The steps in the following sections will help you download your profile data from LinkedIn.

After you download your personal information from LinkedIn, it is converted to a JSON format confirming the standard https://jsonresume.org/schema/

Once the resume is in the JSON format, the script provided here uses a Jinja2 template and your JSON resume to generate a HTML page that looks similar to https://startbootstrap.com/previews/resume/.

The generated HTML file along with other files have to be added to your https://pages.github.io repository

Prerequistes

  • Python3

  • Linux/Unix

  • Git

  • LinkedIn profile

  • Github profile

  • node and npm (Optional)

Clone This Repository

Clone this repository and change the working directory to it.

git clone https://github.com/vamshikr/startbootstrap-resume && cd startbootstrap-resume

Generate JSON resume

This section explains the steps to download your personal information from LinkedIn and convert it to the JSON format

Download your LinkedIn profile

  • Login to Linkedin

  • Select the menu item Me >> Settings & Privacy

  • In the Settings & Privacy page, select the Privacy tab

  • Goto How LinkedIn uses your data >> Get a copy of your data

  • Select Download larger data archive, including connections, contacts, and your account history

  • Click on Request Archive and wait for an email from LinkedIn with the download link

Use the link emailed to you by LinkedIn and download the archive. The archive is in zip file format

Clean the archive (Optional)

The archive that you obtained from LinkedIn has extra personal data related to you other than your profile.

Since an external web-service is used to create the JSON resume, you may want to keep only the required data in the archive.

A bash script clean_zip.sh provided here can be used to create a copy of the archive with only the necessary data for the resume.

./clean_zip.sh ~/Download/Basic_LinkedInDataExport_02-19-2020.zip

Generate JSON resume

Generate HTML

Prerequistes: Your JSON resume

Create Python3 Virtual Environment and Install Requirements

To create a python3 virtual environment and the python dependencies, run the following commands

python3 -m venv venv && source venv/bin/activate && pip install -r requirements.txt

Add image

Replace the file img/profile.jpg with your profile image.

Run generate.py script

Run the generate.py script with the JSON resume file path as the argument

./generate.py resume.json

The generate.py file validates your JSON resume and uses the jinja2 template in jinja2/templates/index.j2 file and generates the HTML and writes it into index.html file

If the generate.py script exits successfully, it creates an index.html file in the current working directory.

Open the index.html file in a browser and verify how it renders.

  • Create an account on GitHub if you don’t already have it.

  • Follow the instructions on https://pages.github.com/#user-site and create a repository by the name <username>.github.io, wherein <username> is your github account name. While creating the repository, do not select initialize the repository with README, nor add any license or .gitignore file

Warning
Do not select initialize the repository with README, nor add any license or .gitignore file
  • In the current working directory, add the newly created GitHub repository as the remote origin

git remote remove origin && git remote add origin [email protected]:<username>.github.io
  • Push to <username>.github.io

git push origin master

Pitfalls

In most cases it is the structure of the file resume.json. Manually examine it and edit it such that it confirms to https://jsonresume.org/schema/

About

A Bootstrap 4 resume/CV theme created by Start Bootstrap

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 52.3%
  • CSS 26.2%
  • JavaScript 14.7%
  • Python 6.8%