Skip to content

Latest commit

 

History

History
74 lines (44 loc) · 2.43 KB

INSTALL.md

File metadata and controls

74 lines (44 loc) · 2.43 KB

Running Ohana Web Search on your computer

Clone the repo to your local machine

git clone git@github.com:codeforamerica/ohana-web-search.git && cd ohana-web-search

Docker Setup (recommended, especially for Windows users)

  1. Download, install, and launch Docker

  2. Copy the sample configuration files:

     $ bin/setup --docker

  3. Build/download the container images:

     $ docker-compose build

  4. Start the app:

     $ docker-compose up

Once the docker images are up and running, the app will be accessible at http://localhost:3000.

More useful Docker commands:

  • Stop this running container: docker-compose stop
  • Stop and delete the containers: docker-compose down
  • Open a shell in the web container: docker-compose run --rm web bash

Local Setup

Before you can run Ohana Web Search, you'll need to have the following software packages installed on your computer: Git, Ruby 2.3+, 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 skip to the next step. Otherwise, there are two ways you can install the tools:

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.

Customize the app

Once you have the app up and running, you will want to customize it to point to your own instance of Ohana API, add your own branding, and much more.