Skip to content

Commit

Permalink
Merge branch 'release/v1.0.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
TheScown committed Jan 29, 2015
2 parents 5ba452e + d770d01 commit cf5cb8a
Show file tree
Hide file tree
Showing 125 changed files with 6,658 additions and 2,451 deletions.
3 changes: 3 additions & 0 deletions .bowerrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"directory": "src/main/webapp/static/lib/"
}
10 changes: 10 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
language: java
jdk:
- oraclejdk7
branches:
only:
- master
- develop
install: true
script: mvn test -P production

12 changes: 0 additions & 12 deletions Cheffile

This file was deleted.

21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2014-2015 Hewlett-Packard Development Company, L.P.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# HP Find
[![Build Status](https://travis-ci.org/hpautonomy/find.svg?branch=master)](https://travis-ci.org/hpautonomy/find)

HP Find is a web application backed by [IDOL OnDemand](https://www.idolondemand.com)

A live preview of HP Find can be found at [find.idolondemand.com](http://find.idolondemand.com).

## Key Features
* Querying IDOL OnDemand indexes
* Viewing IDOL OnDemand results
* Suggested related searches from IDOL OnDemand

## Building HP Find
Building HP Find requires the following to be installed

* [Apache Maven 3](http://maven.apache.org)
* [NodeJS](http://nodejs.org)

The jetty:run goal will stand up a local web server for development. The package goal will build a war file.

Running with the production profile will minify the Javascript and CSS, and bless the CSS for older versions of Internet Explorer.

When developing the develop profile should be used. You will need to create a copy of src/main/filters/filter-dev.properties.example in the same directory.
This should be named filter-dev.properties. This file should be ignored by git.

## HP Find setup
You'll need to install [Tomcat](http://tomcat.apache.org) to run the HP Find war file.

HP Find requires some Java system properties to be set in order to work.
On Linux, one way to do this is by modifying JAVA_OPTS in /etc/default/tomcat7.
On Windows, this can be done with the Tomcat Manager (if installed), or by modifying the JAVA_OPTS environment variable.
If using the jetty:run goal, the properties can be set on the command line
The properties you'll need to set are:

* -Dhp.find.home . This is the directory where the webapp will store log files and the config.json file.
* -Dfind.https.proxyHost . Optional property. The host for the https proxy. Set this if you need a proxy server to talk to IDOL OnDemand.
* -Dfind.https.proxyPort . Optional property. The port for the https proxy. Set this if you need a proxy server to talk to IDOL OnDemand. Defaults to 80 if find.https.proxyHost is defined.

## Configuring HP Find
Once you've started HP Find, you'll need to configure HP Find. When run for the first time, a login screen will appear. The credentials for this are in the config file.

This will take you to the Settings Page. You'll need an IOD API key. Once provided, you can configure which IOD indexes you wish to allow searching against.

You can also configure a user to allow these settings to be changed later. The current password is the password you used to login.
The new password will be stored in the config file as a BCrypt hash.

Once you've configured HP Find, save the config file with the save changes button, and logout. You will be redirected to the Search page. You can access the settings page again by pointing your browser at /find/login (there is no link to this in the UI).

## Is it any good?
Yes.

## License
Copyright 2014-2015 Hewlett-Packard Development Company, L.P.

Licensed under the MIT License (the "License"); you may not use this project except in compliance with the License.
141 changes: 0 additions & 141 deletions Vagrantfile

This file was deleted.

43 changes: 43 additions & 0 deletions bower.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"name": "hp-find",
"version": "1.0.0",
"private": true,
"authors": [
"Alex Scown <[email protected]>",
"Alyona Ivanova <[email protected]>"
],
"moduleType": [
"amd"
],
"license": "MIT",
"ignore": [
"**/.*",
"node_modules",
"src/main/webapp/static/lib",
"src/main/test",
"mockups"
],
"dependencies": {
"backbone": "backbone#~1.1.0",
"colorbox": "colorbox#~1.5.10",
"fontawesome": "components-font-awesome#~3.2.1",
"jquery": "components/jquery#~1.10.2",
"json": "json2#*",
"underscore": "components/underscore#~1.5.2",
"hp-autonomy-js-whatever": "~2.1.0",
"hp-autonomy-login-page": "~1.0.2",
"hp-autonomy-settings-page": "~0.1.0",
"hp-autonomy-bootstrap-2": "~2.3.2",
"requirejs": "~2.1.15",
"requirejs-text": "~2.0.13",
"requirejs-i18n": "~2.0.4"
},
"devDependencies": {
"hp-autonomy-js-testing-utils": "~1.0.2"
},
"resolutions": {
"underscore": "~1.5.2",
"hp-autonomy-js-whatever": "~2.1.0",
"jquery": "~1.10.2"
}
}
10 changes: 10 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"name": "hp-autonomy-find",
"repository": "https://github.com/hpautonomy/find",
"version": "1.0.0",
"devDependencies": {
"bless": "^3.0.3",
"bower": "^1.3.12",
"requirejs": "^2.1.15"
}
}
Loading

0 comments on commit cf5cb8a

Please sign in to comment.