google / voter-info-tool Goto Github PK

/**
 * Copyright 2012 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

//
// Contents
//

The Voter Information Tool is a web based front end to Google's
Civic Information API. The tool is designed to provide relevant voting
information to individual users based on the location at which they are
registered to vote.

//
// Building and Running
//

Requirements:
- bash
- Java JDK 1.6 or newer. Search path must contain 'javac' and 'java'
- Closure Compiler
    => https://code.google.com/p/closure-compiler/
- Closure Template Compiler for Javascript
    => https://code.google.com/p/closure-templates/
- Closure Stylesheet Compiler
    => http://code.google.com/p/closure-stylesheets/
- Closure Library
    => http://code.google.com/p/closure-library/

Environment:
It is useful to have these environment variables set. They may also be passed
as arguments to the src/tools/build script, but that can get a bit verbose.

VIT_JS_COMPILER_JAR => Path to the closure compiler jar file.

VIT_SOY_COMPILER_JAR => Path to the closure template compiler jar file.

VIT_GSS_COMPILER_JAR => Path to the closure stylesheet compiler jar file.

VIT_CLOSURE_LIB_DIR => Path to the closure library directory that contains
    all_tests.html

VIT_SOY_LIB_DIR => Path to the closure template directory that contains the
    file soyutils_usegoog.js

VIT_ANALYTICS_API_KEY => Your Google Analytics API Key.
    If no key is provided, analytics is disabled.

VIT_GOOGLE_API_KEY => Your Google API key. Required for maps, address auto-
    completion and the Civic Info API.

// TODO(jmwaura): flesh out these instructions a bit better as things settle.

//
// Licensing
//

Unless otherwise stated, all source files are licensed under
the Apache License, Version 2.0.