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.
More details regarding the deployment of the Hoaxy frontend to the official site at http://hoaxy.osome.iu.edu can be found in the DEPLOYMENT_README.md file in the deployment branch of this repository.
This is the frontend of Hoaxy, and it is intended to be used in conjunction with an implementation of the Hoaxy backend platform, which is available at: http://github.com/iunetsci/hoaxy-backend
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.
Header, Footer, and Global Includes are located under /includes/.
This site uses PHP to handle templating, which is available by default on many apache servers.
The JavaScript dependencies are listed in 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 Rapid-API. These endpoints should be modified to point to your own implementation of the Hoaxy Backend.
If the back-end is configured to use a local API endpoint in place of RapidAPI, the front-end config needs to use the corresponding local URL. RapidAPI HTTP headers will be ignored.
Make sure you have installed docker-compose.
- Update the config in
frontend/config.jsto reflect rapidapi endpoints. - Run
docker-compose up - Go to your browser and run http://localhost:8080/