INSTALL.md

Running Ohana Web Search on your computer

Install Prerequisites

Before you can run Ohana Web Search, you'll need to have the following software packages installed on your computer: Git, Ruby 2.1+, RVM, and PhantomJS. If you're on a Linux machine, you'll also need Node.js.

If you already have all of the prerequisites installed, you can go straight to the Installation. Otherwise, you'll need to install the following tools manually:

• Build tools
• Ruby with RVM
• PhantomJS (only used for running the tests)
• Node.js (Linux only)

Install Ohana Web Search

Fork and clone

Fork this repository to your GitHub account.

Clone it on your computer and navigate to the project's directory:

git clone https://github.com/<your GitHub username>/ohana-web-search.git
cd ohana-web-search

Install the dependencies and set the default environment variables:

bin/setup

Run the app

Start the app locally on port 4000:

puma -p 4000

Ohana Web Search should now be running at http://localhost:4000

The -p option allows you to specify which port you want to run the server on. This is useful when running other apps at the same time.