Welcome to XIV Bars! This is the source code for the Final Fantasy XIV (FFXIV) Cross Hotbar (XHB) planning tool. This is a passion project created for the purpose of serving the FFXIV community who may have use for a way to port hotbar layouts from the web into the game. It is built in NextJS and is continually being updated.
Made with contrib.rocks.
This project is updated frequently with fixes and new features. I kind of use this project as a space to try new things with javascript and web design, so there may be some lack of structure when updates are deployed live.
- You can submit bug reports from the Issues page.
- 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.
Submit and discuss feature requests from the Feature Requests page.
If you're interested in contributing 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.
If you find this tool helpful, please donate. Donations go towards keeping the app servers and other resources up so that this tool is available to everyone for free.
- Node.js and Yarn (or NPM)
- PostgreSQL
The .env.example file contains all the environment variables used by the app. Copy it into the .env file.
> cp ./.env.example ./.env
To be able to authenticate with the local app, you'll need to set it up with Discord (OAuth2 Documentation).
DISCORD_ID=
DISCORD_SECRET=
JWT_SECRET=
The postgresql database url.
DB_URL=
Install dependencies
> yarn installFetch and compile static data from XIVAPI
> yarn build:dataRunning the app locally
> yarn devOnce the app is running in development mode, open http://localhost:3000 to view it in the browser.
> yarn test