TarkovTracker

A comprehensive web application for tracking your progress in Escape From Tarkov. Track tasks, hideout upgrades, and required items while coordinating with your team.

🚨 Important Notice

This is a community maintained fork of the original TarkovTracker project.

• Original project: https://tarkovtracker.io
• This fork will be hosted at: https://tarkovtracker.org
• The original maintainer @Thaddeus has been inactive (~1 year)
• This fork aims to continue development and maintenance for the community
• The original owner is welcome to regain access/ownership if they return
• While not a primary focus, we commit to reviewing PRs and maintaining dependencies

✨ Features

• Track tasks and objectives by trader and map
• Monitor hideout upgrade progress
• Track required items for tasks and hideout upgrades
• Team system for coordinating with friends
• Works offline using local storage
• No authentication required for basic functionality

🤝 Contributing

We welcome all contributions! This is a community-driven project.

• All contributions, big or small, are appreciated
• Constructive feedback will be provided on all PRs
• Previous contributors/maintainers from the original project are welcome to reach out
• Looking to become a maintainer? Show dedication through quality contributions

🛠️ Development Setup

Prerequisites

• Node.js 18.0 or higher
• Java JRE 11+ or higher (for Firebase Emulator)

Installation

1. Clone the repository

2. Install dependencies by running npm install in the root directory. This will install dependencies for both frontend and functions workspaces.

3. Start development server:

   Run npm run dev from the root directory. This command will concurrently start the frontend development server and the Firebase emulators.

Other Useful Commands

• npm run lint: Lints the codebase to ensure code quality and consistency.
• npm run format: Formats the code according to the project's Prettier configuration.
• npm run build: Builds the project (both frontend and functions). The frontend output will be in the frontend/dist directory.

🏗️ Project Structure

The project consists of two main components:

1. Frontend (SPA)

   • Located in /frontend
   • Built with Vue.js
   • Can function independently using local storage

2. Backend (API)

   • Located in /functions
   • Built with Firebase Cloud Functions
   • Required only for team features and third-party API access

📝 License

This project retains the original GNU General Public License v3.0 from the original TarkovTracker project. See LICENSE.md for the full license text.

🙏 Acknowledgments

• Original TarkovTracker team and @Thaddeus
• All contributors and community members

Folder Structure

• /functions: Contains the Firebase Cloud Functions (Node.js/TypeScript).
• /frontend: Contains the frontend application (Vue 3/Vite).
  • Located in /frontend
  • Built using Vue 3, Vite, TypeScript, Vuetify, Pinia.
• /docs: Contains the API documentation generated by Swagger/OpenAPI.