Git Product home page Git Product logo

tarkov-dev's Introduction

tarkov.dev ๐Ÿ’ป

ci CodeQL Discord

This is the source code for the official tarkov.dev website.

View Escape from Tarkov information about items, barters, trades, flea market prices, quests, maps, hideout profits, and so much more!

homepage

Local Development ๐Ÿ”จ

To build and test the site locally just follow the steps below:

  1. Install dependencies:

    npm install
  2. Start development server:

    npm start
  3. Access the site: localhost:3000 ๐ŸŽ‰

Note: You can update data with: npm run prebuild

History ๐Ÿ“š

This project (tarkov-dev) is a fork of tarkov-tools.com. The original creator @kokarn decided to shut the site down. In the spirit of open source, a group of developers came together to revive the site in order to continue providing a great website for the Tarkov community and an API to power further development for creators. This project is now 100% open source (see infrastructure section below) and developer first. Our GitHub Organization (the-hideout) contains all the repos which power the API, this website, the community Discord bot, server infrastructure, and much more! We are passionate about open source and love pull requests to improve our ecosystem for all.

We โค๏ธ Pull Requests

We love pull requests and contributors looking to improve this project! Anything from simple spelling errors, icon updates, fixes for small css bugs or just posting issues to keep track of what needs to be done is greatly appreciated.

Deployment ๐Ÿš€

Deploying your changes to production is easy! Just do the following:

  1. Open a pull request with your changes
  2. Make sure CI is passing (a core member of the-hideout will run CI for you)
  3. A core member of the-hideout will run .deploy to development to deploy your changes to the development environment for final validation
  4. A review will be recieved from a reviewer if all looks good
  5. A core member of the-hideout will run .deploy on your pull request to branch deploy your changes to production
  6. If everything goes okay, your PR will be merged and your changes will be auto-deployed to production! โœจ

Updating Languages ๐ŸŒ

To update the supported languages used by the site with the GraphQL API, you will need to edit the following file: supported-languages.json

See this pull request for additional context

Other Parts of the Ecosystem ๐ŸŒŽ

  • Stash - The official tarkov.dev Discord bot
  • Tarkov API - The GraphQL API that powers everything
  • Tarkov Data - Open source structured data for Escape from Tarkov
  • Tarkov Image Generator - Tool to generate images from the local icon cache
  • Tarkov Data Manager - Data manager that core contributors to the project can use to update items in the database. It also contains cron jobs that sync database information to our Cloudflare workers for the GraphQL API
  • Cache - A bespoke caching service to cache frequent GraphQL API queries
  • Status - The official status page for tarkov.dev, api.tarkov.dev, and much more

Infrastructure ๐Ÿงฑ

To learn more about the infrastructure, components, and open source pieces of this project, check out our infrastructure documentation

Contributors ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘

Thank you to all of our awesome contributors! โค๏ธ

tarkov-dev's People

Contributors

kokarn avatar grantbirki avatar oskarrisberg avatar gyran avatar razzmatazzz avatar austinhodak avatar shebuka avatar thaddeus avatar akiyamov avatar significant-quart avatar dependabot[bot] avatar rm-evans avatar khamer avatar lipowskm avatar heybanditoz avatar atunamelt avatar heywod avatar xpolarium avatar mkim219 avatar streeetlamp avatar tiddle avatar faalagorn avatar github-actions[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.