Skip to content

chore: Add a pre-built dev environment #595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
v6 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: Add a pre-built dev environment #595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,53 @@ to test the cli, run the dev script:
npm run dev -- [cli arguments can be passed after the double-dash]
```

# Vagrant Development Environment

To use the [Vagrant](vagrantup.com/) Development Environment:

## Install Virtualbox

The Virtual Machine for Vagrant for the developer environment for this will run in
[Virtualbox](https://www.virtualbox.org/), a Virtual Machine provider.

Vagrant will then help you configure the Virtual Machine in Virtualbox to work with
this code.

Before installing Vagrant, make sure you can successfully download and install
Virtualbox from [Virtualbox.org](https://www.virtualbox.org/wiki/Downloads).

## Install Vagrant

https://duckduckgo.com/?q=install+vagrant

## Run Vagrant

Use your terminal to navigate to the top level of this folder,
by changing into the directory you just cloned with `cd resume`.

Then run `vagrant up` and `vagrant ssh`.

You should see the command prompt change, and this means you're ready to start!

Side note: If you ever want to exit the Vagrant prompt, just enter the `exit` command
and you'll see your command prompt change back to normal.

If you run into an error complaining about `bsdtar`, just try installing libarchive as described here: https://github.com/hashicorp/vagrant/issues/6390

If you get an error about default providers, make sure you have the latest version of Virtualbox installed.

```sh
vagrant up
vagrant ssh
cd /vagrant
ls # Should show a file named resume.json
resume validate
npm install jsonresume-theme-stackoverflow # Just in case
resume export --format html --theme stackoverflow resume-$(date +"%m-%d-%y").html
cp /www/html/sites/resume/resume.html /www/html/sites/resume/resume.html.$(date +"%m-%d-%y").bak
cp resume-$(date +"%m-%d-%y").html /www/html/sites/resume/resume.html
```

# License

Available under [the MIT license](http://mths.be/mit).
125 changes: 125 additions & 0 deletions Vagrantfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
# -*- mode: ruby -*-
# vi: set ft=ruby :

$script = <<-SCRIPT
echo I am provisioning...
date > /etc/vagrant_provisioned_at
runuser -l vagrant -c 'curl -s -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.36.0/install.sh | bash'
echo 'export NVM_DIR="/home/vagrant/.nvm"' >> /home/vagrant/.bashrc
echo '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm' >> /home/vagrant/.bashrc
echo '[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion' >> /home/vagrant/.bashrc
echo 'export NVM_DIR="$HOME/.nvm"' >> /home/vagrant/.bashrc
echo '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm' >> /home/vagrant/.bashrc
echo '[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion' >> /home/vagrant/.bashrc
echo 'npm update npm # This updates NPM on every login' >> /home/vagrant/.bashrc
runuser -l vagrant -c ' source /home/vagrant/.bashrc'
runuser -l vagrant -c 'export NVM_DIR="/home/vagrant/.nvm"'
runuser -l vagrant -c '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm'
runuser -l vagrant -c '[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion" # This loads nvm bash_completion'
runuser -l vagrant -c ' source ~/.bashrc'
runuser -l vagrant -c 'command -v nvm'
echo "INSTALLING NVM, NPM, AND RESUME-CLI ALL AT ONCE"
runuser -l vagrant -c 'source ~/.nvm/nvm.sh && nvm install node && npm install npm@latest -g && npm install -g resume-cli && npm -v'
runuser -l vagrant -c 'source ~/.nvm/nvm.sh && npm install jsonresume-theme-stackoverflow && npm install'\
'jsonresume-theme-flat && npm install jsonresume-theme-clean && npm install jsonresume-theme-modern && npm install jsonresume-theme-printclassy && npm -v'
echo "## Make the welcome message"
bash -c "cat >/home/vagrant/.welcometext.sh" << EOF
echo " _
(_)
_ __ ___ ___ _ _ _ __ ___ ___ _ ___ ___ _ __
| '__/ _ \\\/ __| | | | '_ ' _ \\ / _ \\ | / __|/ _ \\| \'_ \\
| | | __/\\__ \\ |_| | | | | | | __/_| \\__ \\ (_) | | | |
|_| \\___||___/\\__,_|_| |_| |_|\\___(_) |___/\\___/|_| |_|
_/ |
|__/ "
echo ""
echo ""
echo "usage guide: https://github.com/jsonresume/resume-cli#usage"
echo "resume validate"
echo "resume export --format pdf resume-$(date +"%m-%d-%y").pdf"
echo "resume export --format html resume-$(date +"%m-%d-%y").html"
echo "resume export --format html --theme stackoverflow resume-$(date +"%m-%d-%y").html"
echo "resume export --format html --theme slick resume-$(date +"%m-%d-%y").html"
echo "Or, if you like you can run the command 'resume' on its own, to see usage."
EOF
cat .welcometext.sh
echo "bash ~/.welcometext.sh" >> /home/vagrant/.bashrc
echo "usage guide: https://github.com/jsonresume/resume-cli#usage"
echo "resume validate"
echo "resume export --format pdf resume-$(date +"%m-%d-%y").pdf"
echo "resume export --format html resume-$(date +"%m-%d-%y").html"
echo "resume export --format html --theme stackoverflow resume-$(date +"%m-%d-%y").html"
echo "resume export --format html --theme slick resume-$(date +"%m-%d-%y").html"
echo ""
echo "Or, to see usage, run the command 'resume' after you run 'vagrant ssh' to log in to the Vagrant box."
SCRIPT


# All Vagrant configuration is done below. The "2" in Vagrant.configure
# configures the configuration version (we support older styles for
# backwards compatibility). Please don't change it unless you know what
# you're doing.
Vagrant.configure("2") do |config|
# The most common configuration options are documented and commented below.
# For a complete reference, please see the online documentation at
# https://docs.vagrantup.com.

# Every Vagrant development environment requires a box. You can search for
# boxes at https://vagrantcloud.com/search.
config.vm.box = "bento/ubuntu-20.04"

# Disable automatic box update checking. If you disable this, then
# boxes will only be checked for updates when the user runs
# `vagrant box outdated`. This is not recommended.
# config.vm.box_check_update = false

# Create a forwarded port mapping which allows access to a specific port
# within the machine from a port on the host machine. In the example below,
# accessing "localhost:8080" will access port 80 on the guest machine.
# NOTE: This will enable public access to the opened port
# config.vm.network "forwarded_port", guest: 80, host: 8080

# Create a forwarded port mapping which allows access to a specific port
# within the machine from a port on the host machine and only allow access
# via 127.0.0.1 to disable public access
# config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1"

# Create a private network, which allows host-only access to the machine
# using a specific IP.
# config.vm.network "private_network", ip: "192.168.33.10"

# Create a public network, which generally matched to bridged network.
# Bridged networks make the machine appear as another physical device on
# your network.
# config.vm.network "public_network"

# Share an additional folder to the guest VM. The first argument is
# the path on the host to the actual folder. The second argument is
# the path on the guest to mount the folder. And the optional third
# argument is a set of non-required options.
# config.vm.synced_folder "../data", "/vagrant_data"

# Provider-specific configuration so you can fine-tune various
# backing providers for Vagrant. These expose provider-specific options.
# Example for VirtualBox:
#
# config.vm.provider "virtualbox" do |vb|
# # Display the VirtualBox GUI when booting the machine
# vb.gui = true
#
# # Customize the amount of memory on the VM:
# vb.memory = "1024"
# end
#
# View the documentation for the provider you are using for more
# information on available options.

# Enable provisioning with a shell script. Additional provisioners such as
# Ansible, Chef, Docker, Puppet and Salt are also available. Please see the
# documentation for more information about their specific syntax and use.
# config.vm.provision "shell", inline: <<-SHELL
# apt-get update
# apt-get install -y apache2
# SHELL
config.vm.provision "shell", inline: $script
end