Tool Requirements

  1. Homebrew Package Manager
  2. Git version control system. Using the, execute the following:
    brew install git
  3. Ruby language. Using the, execute the following:
    brew install ruby
  4. Bundler, Ruby environment manager. Using the, execute the following:
    gem install bundler
  5. VS Code Editor Download the package and install

SSH keys

In order to use Github securely, we will generate a SSH key and grant it access to our Github account Follow the directions outlined here

Github Repository Open your and execute the following commands to clone a copy of the repository to your PC

cd Documents
git clone [email protected]:OAXFoundation/
bundle install

Running the website on your PC In the

cd ~/Documents/
bundle exec jekyll serve

The first time may take a while as Jekyll generates all the files for our website but afterwards you should see this:

[email protected]  ~/work/oax/   master  bundle exec jekyll serve                                                          [12:00PM]
Configuration file: /Users/waylandchan/work/oax/
            Source: /Users/waylandchan/work/oax/
       Destination: /Users/waylandchan/work/oax/
 Incremental build: disabled. Enable with --incremental
                    done in 6.409 seconds.
 Auto-regeneration: enabled for '/Users/waylandchan/work/oax/'
    Server address:
  Server running... press ctrl-c to stop.

Now that the site is running locally, you can press CMD and click on the link (shown in to open the site in your browser.

You can make changes to your website and they will be automatically detected by Jekyll. To see the changes, simply refresh your browser. Once you are finished, you can exit by hitting CTRL-C in

Directory Structure