TarkovTracker is a progress tracker meant to help players of Escape From Tarkov. The core goal of the project is to provide insights into what to do next, and make it easier to work with friends as you progress to Epsilon, Kappa, Trader loyalty levels, or a maxed out hideout.
Tarkov Tracker has some prebuilt data baked in. This is the quest and hideout data encoded in JSON. The questData.json and hideoutData.json files are deployed with the application, and imported at runtime for reference. These files are a git submodule of the https://github.com/TarkovTracker/tarkovdata repository. Structural changes to these files may break TarkovTracker, so for now this data will be manually pulled to newer versions to verify data integrity.
- Node v14 (LTS) or higher
- Firebase Tools (npm package installed globally)
First time setup can be done by running the following:
git clonethe repositorygit submodule initto set up the TarkovData submodule (required)git submodule updatepulls the pinned commit for the submodule (required)npm installinside the repository to install all the dependencies
If you work on anything that utilizes the Firebase Cloud Functions, you will also need to run npm install inside the functions folder.
Now you can run the project locally!
npm run serve results in localhost:5000 for Web APP, and localhost:4000 for emulator UI
You can modify the serve command and run as npm run serve:persist to keep Firebase emulator data across multiple sessions of the emulator. Otherwise, the firestore database and authentication will be reset each emulator session.
Access the local environment at http://localhost:5000 by default. This project is built to be hosted via Google Firebase. The Firebase Emulator will be installed via npm when setting up the project. Included is a hosting, database, authentication, and function emulator. The emulator console is available at http://localhost:4000 by default. These resources cost money to run on the production version of TarkovTracker. Thankfully to Patrons, this is covered, and isn't a blocker to new features utilizing them, but please be aware of the scale of potential resource use of new features!