Skip to content

sciku1/Universalis

 
 

Repository files navigation

Documentation Codacy Badge Security Headers

Universalis

A crowdsourced market board aggregator for the game FINAL FANTASY XIV.

API Reference

Please refer to the documentation for basic usage information.

API Development

Developing and testing the API server requires Visual Studio 2022 Preview, as it targets .NET 6. It also requires MongoDB Community Edition v4.4.

This application uses some F# code, which needs to be built before IntelliSense can navigate it. If you get any undefined references to F# code, just build the Universalis.DataTransformations project.

Frontend Development

The frontend is housed on our mogboard fork, where contributions are welcome.

Upload Software Development

Please see goat's ACT plugin for an example of how to collect and upload market board data.

Development

Requires .NET 6, PHP 7.2, MariaDB, Redis, Composer 1, and MongoDB Community Edition v4.2 or higher.

Also build a DataExports and an icon2x by running the exporter solution.

Uncomment/add in php.ini:

extension=redis.so

MariaDB commands:

CREATE DATABASE `dalamud`;
CREATE USER 'dalamud'@localhost IDENTIFIED BY 'dalamud';
GRANT ALL PRIVILEGES ON `dalamud`.* TO 'dalamud'@localhost IDENTIFIED BY 'dalamud';
FLUSH PRIVILEGES;

Setup script (mogboard):

composer install
php bin/console doctrine:schema:create
php bin/console PopulateGameDataCommand -vvv
php bin/console ImportTranslationsCommand -vvv
yarn
yarn dev
symfony server:start -vvv --port 8000

To update

Go to the mogboard/ folder, and execute the following commands after adding any new front-end data.

sudo rm -rf var/
sudo redis-cli FLUSHALL
sudo php bin/console PopulateGameDataCommand -vvv
sudo php bin/console ImportTranslationsCommand -vvv
sudo chmod 0777 var/ -R

Single-line form

sudo rm -rf var/ && sudo redis-cli FLUSHALL && sudo php bin/console PopulateGameDataCommand -vvv && sudo php bin/console ImportTranslationsCommand -vvv && sudo chmod 0777 var/ -R

About

A crowdsourced market board API for FFXIV.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 97.9%
  • PowerShell 0.6%
  • F# 0.5%
  • Shell 0.4%
  • HTML 0.3%
  • Dockerfile 0.2%
  • Batchfile 0.1%