Mac-Install
angela edited this page 5 years ago

Installation Instructions for MacOS

A detailed set of instructions for first-time installs, with dependencies needed for Resgen's operation, along with explanations of why we need them. First-time installation is the only time you'll have to put any effort into using Resgen!

Once everything is set up, there's one command to run any time you want to launch it.

Install Homebrew & Git (latest version)

  • Homebrew is a Mac-based package manager that brings Linux-like capabilities to Mac for installing applications.

Launch your terminal program and run the following commands

You may be prompted more than once for your sudo password (root/administrator), as some applications have to be installed in high-level directories, in order to function.

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Then:

brew doctor
  • Git makes it easy to obtain the codebase and keep your installation up-to-date (if you want new features of Resgen)
brew install git

Check Ruby

Ruby is the programming language that powers this application and handles the automation

Mac's have Ruby pre-installed, but if you don't regularly update your Mac (or Apple decides they don't need a later version), it may be out of date. In your terminal, run the following to check what version of Ruby you're running:

ruby -v

If it's anything below 2.4.x, you'll want to either run any pending updates on your Mac (recommended) to see if Ruby updates, or install RVM to run different versions virtually. Follow these Instructions if you need RVM.

Get Resgen

From the Command Prompt Terminal, we'll obtain Resgen's source code, using Git:

git clone https://notabug.org/angela/resgen.git && cd resgen

sudo warning

During the automated dependency install, you may encounter a bundler warning, like so: bundler warning

Aside from using RVM, there isn't a way around this; as the component files install themselves to elevated directories that standard user accounts cannot write to. In my tests, Resgen was able to utilize everything installed, despite the notice.

Easy application dependency installs

These programs can be installed to the default location the installer wants to send them to. Make sure you add them to Applications, when prompted.

  • Firefox - utilized by the scraper to save the job postings
  • LibreOffice - The free software version of MS Office; this is where our resume templates will be handled and kept

Done!

Anytime you want to launch Resgen, simply run:

ruby resgen

from inside the Resgen directory.

Your resumes are saved to resgen/finished_resume unless you specified a custom location in config.yml

Hit a snag during install? Check the Install help wiki for solutions