The name Hoaxy is a trademark of Indiana University. Neither the name "Hoaxy" nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
There are two primary branches in this repository. The
master branch is the generic, unbranded version of the frontend.
deployment features branding, styles, and customizations featured only on the official website.
master should be merged into
deployment when new features have been added.
deployment should never be merged into
master, and as such, should only include additions specific to the live site.
We strongly recommend that you implement the Hoaxy backend before this frontend. For more information, including a description of the application and information on how to collaborate with the Hoaxy team, please visit the official Hoaxy website.
Templating and Server
Header, Footer, and Global Includes are located under
This site uses Server Side Includes (SSI) to handle the header and footer. SSIs are built into Apache, but may need to be enabled. To enable SSI for
.html extension, you could follow this instruction Basic SSI. As such, we recommend running this on an Apache server. More research may be required to utilize SSIs on non-Apache servers. Other methods of including the required files (such as the Flask templates) may require modifications of the code or installation of additional libraries. In the event that using SSIs is impractical or impossible, you should copy the code from the include files directly into
includes/includes.html. Many libraries are included via CDNs.
The graph visualization uses Sigma.js, and it was tested with v1.2.0. The timeline chart is implemented using NV.D3, a plugin for D3.js, and it was tested with NV.D3 v1.8.1 and D3 v3.5.17. Feel free to use more recent versions at your own risk.
API endpoints must be defined in a
frontend/config.js. An example config file -
config.example.js - has been provided to show you the correct format. It features endpoints from the public Hoaxy Mashape API. These endpoints should be modified to point to your own implementation of the Hoaxy Backend.