tokataka/xiv-bars

The source code for the Final Fantasy XIV W Cross Hotbar (WXHB) Planning and Simulation Tool built in NextJS.

XIV Bars

FFXIV XHB Cross Hotbar Planner/Simulator

https://xivbars.bejezus.com

The source code for the Final Fantasy XIV Cross Hotbar (XHB) Planning and Simulation Tool built in NextJS.

---

Table of Contents

• Contrubuting
  • Report Bugs
  • Request Features
  • Contribute Code
  • Donate
• Dev Environment
  • Setting up
  • Running the app

How to Contribute

Report Bugs

Submit bug reports in the Issues section. Please make sure that the issue you're submitting doesn't already exist. Include step-by-step instructions on how to reproduce, as well as the operating system (OSX, Windows, etc.) and browser (Chrome, Firefox, etc.) you're using when encountering the issue.

• View Bug Reports

Request Features

Submit feature requests from the Issues section. Please make sure that the issue you're submitting doesn't already exist. Include a detailed description of the feature being requested and how it should work.

• View Open Feature Requests

Find an Issue to Work On

If you're interested in contributing some code, take a look at open issues and create a pull request that addresses it. I'll review when I get the chance, but please be patient.

• View Open Issues
• View the Web Project
• Setting up a Dev Environment

Donate

If you find this tool helpful, please consider donating. Donations go towards paying for app servers and other resources to make this tool available to everyone for free.

• Donate

Setting up a Dev Environment

Install Node

You'll need to install Node.js and Yarn (or NPM)

Running the app (using Yarn)

Install dependencies

yarn install

Fetch and compile static data from XIVAPI

yarn build:data

Running the app locally

yarn dev

Once the app is running in development mode, open http://localhost:3000 to view it in the browser.

Running Tests

yarn test