README.md

open-austin.org

The Open Austin website

• How to Draft a Blog Post
• Development Instructions
• Planning
• License

---

Development Instructions

Required System Installs (if you haven't already)

• Install homebrew (for better installation of OS X packages)
  • ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
• Install OSX Xcode command line tools if you haven't
  • xcode-select --install

Installing Jekyll/Ruby on OS X

OS X comes with Ruby 2.0.0, but its not the latest version and you may have to use the sudo command to do anything. Best to install a version manager like ruby-install + chruby to help with that.

If you already use rbenv or another Ruby version manager, you should be good as long as you use ruby 2.4.2+.

• Install ruby-install for installing Ruby versions. Jekyll requires at least Ruby 2.1 but we recommend Ruby 2.4+

  • brew install ruby-install
  • ruby-install ruby 2.4.2

• Install chruby to switch ruby versions.

  • brew install chruby
  • chruby ruby 2.4.2
  • Copy source /usr/local/share/chruby/chruby.sh into your ~/.bashrc file (or if you use Zsh, .zshrc). Save that file and start a new terminal.

• Install jekyll to install Jekyll. - Install jekyll to install Jekyll.

  • gem install jekyll

• Install Ruby Bundler, the best way to manage Ruby gems (packages)

  • gem install bundler

Start Jekyll

Next, clone down this repo with

git clone https://github.com/open-austin/open-austin.github.io.git

Then, navigate to that directory using

cd open-austin.github.io

After everything is correctly installed and you are in the home directory, run

bundle install

Then,

bundle exec jekyll serve --incremental --watch --trace

Then go to

http://localhost:4000/

Troubleshooting

• If you run into errors that look like zsh: command not found: chruby you may need to update your .bashrc or .zshrc file which is a shell script that runs and initializes your shell whenever you open a new terminal.

  • https://github.com/postmodern/chruby/blob/master/README.md#configuration
  • https://unix.stackexchange.com/questions/129143/what-is-the-purpose-of-bashrc-and-how-does-it-work

• If you get permissions errors, run the command again with 'sudo'

sudo <your> <command here>

Instructions for exporting content from Wordpress

gem install jekyll-import hpricot open_uri_redirections
ruby -rubygems -e 'require "jekyll-import";
    JekyllImport::Importers::WordpressDotCom.run({
      "source" => "import/openaustin.wordpress.2015-11-21.xml",
      "no_fetch_images" => false,
      "assets_folder" => "assets"
    })'

---

Planning

Staging Site: http://open-austin.github.io/

Planning & Design

Sitemap

link to Gliffy

Design Docs

[Design Brief](planning-design/planning_and_analytics/OA Design Brief.pdf?raw=true)

Colors/Typography

Mockups

Homepage Mockups from 1-Sept

Higher fidelity Mockup from 24-Aug Meeting ([PDF](planning-design/other_mockups/OA Homepage 1.pdf?raw=true) AND [Sketch](planning-design/other_mockups/OA Homepage 1.sketch?raw=true))

Original Lo-fi Mockup

Requirements

Link to functional requirements doc

Assets/Images

Links to potential assets/images

License

The code for this repository has been released into the public domain by Open Austin via the Unlicense.