antitcb / nexushub Goto Github PK

NexusHub is an online service which provides insights on game economics and other ingame data. We pride ourselves on the freedom that we take to gather our data - If it's there, we'll find some way to extract it. This repo contains the application logic for our servers, including all statistics calculations. For data-tracking via OCR, please see nexus-sentry.

You can find the live version of the latest features from the development branch at staging.nexushub.co

Documentation
API client

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing and then open an issue regarding your concern.

NexusHub is entirely developed by community members of the games we support, so if you wanna join our team as a regular contributor, you're more than welcome!

If you need an introduction to our code base, feel free to ask us on Discord! Though, we generally recommend going through the "Getting started" tutorial for Cubic first. It's the framework that powers nearly everything on our webserver and web app.

Make sure you have Docker installed first - we recommend following the installation instructions in our docker repo. Once installed, locate this repo and run:

sudo bash docker.sh

This will automatically install and run all required services. Feel free to grab a coffee while waiting for the first install, it'll probably take a few minutes. Once done, check out localhost:3000 and start hacking! You're gonna find all API endpoints in /api while all sites and UI elements are in /ui.

To stop the service again, just run

docker stack rm nexus

Like what we do? Leave a star to make this little robot happy ❤️

CC BY-NC 4.0