lucidworks/fusion-seed-app

Name: fusion-seed-app

Owner: Lucidworks

Description: Angular app to facilitate the creation of demos for PoCs/pilots

Created: 2015-04-17 19:17:44.0

Updated: 2017-01-03 20:47:45.0

Pushed: 2016-05-31 18:59:20.0

Homepage: null

Size: 402

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

The Fusion seed app is a tool that aims to provide:

• A starting point for customizable demos, proof-of-concepts, and pilot projects.
• A reference application for integrating Fusion into web applications.

Installation Requirements

This repository is packaged with a node http server and install, start and stop scripts. If you wish to use these scripts then node is a requirement.

• Node

Installing and Running

1. git clone https://github.com/LucidWorks/fusion-seed-app.git
2. cd fusion-seed-app
3. bin/install
4. bin/start
5. Go to http://localhost:8000/app/#/ecomm

By default, this will point to an existing Fusion server hosted on AWS. To point this to another server and for other application settings see app/ecomm/services/ecomm-service.js

Features

• Easy to skin
• Can run on any server technology that can serve HTML and javascript files.
• Signals, Aggregations and Recommendations (EventMiner coming soon)
• Product page demonstrating 3 different recommendation types.
• Dynamic faceting
• Auto-complete (built on signals_aggr by default)
• Spell-checking (“did you mean..” suggestions)
• Developer assistance (shows live requests being sent to Fusion and the JSON responses).

Roadmap

• Paging
• EventMiner

Notes On Skinning

This app uses Bootstrap and AngularJS. It uses Bootstrap's grid system to control page layout. Here is a list of files of interest that could be modified in order to customize the skin:

• app/index.html - The header and footer.
• app/ecomm/view-search.html - Everything in-between the header and footer including the 2 column layout.
• app/app.css - All custom styles.
• Directives - if you need to change something specific such as the way a facet is displayed, you can modify the custom directives directly. See notes on Project Structure below.

Project Structure

This project is made up of several modules. Each module adheres to the following structure:

• app/module_name - Contains the module, including any controllers and views.
• app/module_name/directives - Contains custom directive js and html files for the module.
• app/module_name/services - Contains any custom services for the module.

Module Descriptions

• app/ecomm - Contains the e-commerce demo.
• app/solr - Contains any directives, services, controllers, or views that encapsulate Solr-related functionality. For this app, it is just a handful of directives for rendering elements from a Solr response.
• app/fusion - Contains any directives, services, controllers, or views that encapsulate Fusion-related functionality. This includes a simple wrapper of Fusion's REST API using Angular's $http service.

CORS Proxy

You may notice that requests to Fusion are being sent to port 9292. This is the address of a proxy server running on the Fusion server. This proxy provides 2 things:

• CORS enabled - This is required in order to send client-side requests to Fusion.
• Username/Password Protection - Since the proxy contains the basic auth headers, and it is running on the server, it means credentials are hidden from clients.

A simple Node proxy server has been packaged with this application in proxy-server. It must be started separately using the following steps:

On your Fusion server

1. git clone https://github.com/LucidWorks/fusion-seed-app.git
2. cd fusion-seed-app/proxy-server
3. bash start.sh
4. Go to http://your_server:9292/