TarkovTracker

A community-maintained web application for planning and tracking your Escape From Tarkov progression. TarkovTracker keeps tabs on tasks, hideout upgrades, and required items so you can focus on raids while sharing progress with your squad.

Project Status This repository is a community fork of the original TarkovTracker project. The official production instance continues to live at https://tarkovtracker.io and this fork is developed and hosted by volunteers at https://tarkovtracker.org while the original maintainer is inactive. If the original owner returns, stewardship will gladly be transferred back.

---

Table of Contents

• Features
• Architecture overview
• Getting started
  • Prerequisites
  • Quick start
  • Available scripts
• Project structure
• Documentation
• Deployment & hosting
• Community & support
• Contributing
• Code of Conduct
• License
• Acknowledgments

Features

• Track trader tasks and objectives with filtering by map, type, and status
• Monitor hideout module requirements and completion progress
• Keep a centralized list of required items for quests and upgrades
• Collaborate with friends using the built-in team system backed by Firebase
• Enjoy offline-ready functionality thanks to local storage and PWA support
• Benefit from an open API and generated documentation for integrations

Architecture overview

TarkovTracker is built as a modern Jamstack-style application:

• Frontend – A Vue 3 + Vite single-page application (SPA) with TypeScript, Pinia for state management, and Vuetify for UI.
• Backend – Firebase Cloud Functions provide team syncing, authentication, and access to external services when needed.
• Data – Firestore rules, indexes, and emulators are versioned in this repository for reproducible environments.
• Tooling – The monorepo is managed with npm workspaces. Linting, formatting, and TypeScript support are configured via ESLint, Prettier, and shared configs.

Getting started

Prerequisites

• Node.js 18 or newer (installs npm automatically)
• Java 11+ Runtime Environment (required for Firebase emulators)
• Optional: Firebase CLI if you prefer to manage emulators separately

Quick start

# Clone the repository
git clone https://github.com/TarkovTracker/tarkovtracker.git
cd tarkovtracker

# Install dependencies for all workspaces
npm install

# Run the frontend and Firebase emulators together
npm run dev

The application will start a Vite development server (default http://localhost:5173) alongside local Firebase emulators.

Available scripts

The root package.json exposes helpful scripts for daily development:

Command	Description
npm run dev	Starts the frontend dev server and Firebase emulators concurrently.
npm run build	Builds the Vue frontend (frontend/dist) and Firebase Functions bundle.
npm run lint	Runs ESLint across the monorepo.
npm run format	Formats the codebase using Prettier.
npm run docs	Generates the OpenAPI spec and Swagger UI assets in the docs/ directory.
npm run emulators	Builds functions and launches the Firebase Emulator Suite.

Project structure

TarkovTracker/
├── frontend/           # Vue application (pages, components, assets)
├── functions/          # Firebase Cloud Functions (TypeScript)
├── docs/               # Generated API documentation (OpenAPI + Swagger UI)
├── firestore.rules     # Firestore security rules
├── firestore.indexes.json
├── database.rules.json # Realtime Database rules (if needed for features)
├── SCRIPTS.md          # Reference for automation and maintenance scripts
├── CHANGELOG.md        # Release highlights and version notes
└── CONTRIBUTING.md     # Contribution guidelines

Documentation

• User & feature guides – Work-in-progress documentation lives in the docs/ directory and at https://tarkovtracker.org/docs when deployed.
• API reference – View the generated OpenAPI specification (docs/openapi.json) or open the embedded Swagger UI (docs/index.html).
• Changelog – Review notable updates in CHANGELOG.md.

We welcome additional documentation improvements! Open an issue or pull request if you find gaps.

Deployment & hosting

• The community fork is deployed to https://tarkovtracker.org.
• Firebase hosting is used for both the SPA and backend functions. Deployment is managed through the Firebase CLI and CI/CD pipelines.
• Secrets, service accounts, and production data are not included in this repository. Please coordinate with maintainers before attempting production deployments.

Community & support

• Questions & ideas – Use GitHub Discussions or open an issue.
• Live chat & squads – Join the TarkovTracker Discord to coordinate raids, ask questions in real time, or hang out with fellow Tarkov fans.
• Bug reports – File an issue with clear reproduction steps and screenshots/logs when possible.
• Security concerns – Follow our security policy for responsible disclosure.
• Need to talk to a human? – Reach out via [email protected].
• More resources – See SUPPORT.md for additional help channels and troubleshooting tips.

Contributing

We enthusiastically welcome contributions from the Escape From Tarkov community! Please read our CONTRIBUTING guidelines for details on development workflows, coding standards, testing expectations, and how to propose large features.

If you are unsure where to begin, check the issue tracker for labels such as good first issue, help wanted, or reach out on Discussions.

Code of Conduct

Participation in this project is governed by our Code of Conduct. We are committed to providing a welcoming and harassment-free experience for all community members.

License

This project remains licensed under the GNU General Public License v3.0. See LICENSE.md for the full license text.

Acknowledgments

• The original TarkovTracker team and @thaddeus
• Contributors and testers who keep the project alive
• The Escape From Tarkov community for continued enthusiasm and support