Skip to content

Latest commit

 

History

History
187 lines (141 loc) · 7.07 KB

README.md

File metadata and controls

187 lines (141 loc) · 7.07 KB
Raw

pubg heatmap

An analytic tool for Player Unknown's Battle Ground - PUBG

Code style Open Source Love

Found it useful? Want more updates?

Show your support by giving a ⭐

Buy Me a Coffee Become a Patron

This app provides the front end which includes the heatmap and rendering of the 2D replay on canvas with React. See also pubgheatmap/backend.


✨ Note: This library is based on pubgsh/client with more features and cooler designs. I’m happy to consider suggestions, pull requests and bug reports.


Screenshot

pubg heat map

About

  • This project belongs to Mediusoft.
  • We use:
    • Library - React.js,
    • Query language - GraphQL
    • React UI framework - Material-UI,
    • Styling - JSS,
    • IDE - VS Code,
    • Code analysis tool - Eslint
  • 🤝 Bingo! If you are familiar with these tools then you're ready to continue further developing this project.

Configuration

  1. Create .env.local dotenv file in the root of the project and provide the following values:
  • REACT_APP_API (Where you have the companion)

Quick Start

  • Install dependencies by running yarn or npm install.
  • Run yarn start or npm run start to start the local development server.
  • 😎 That's it! You're ready to start improving the project.

Project Structure

  • This project is bootstrapped using Create React App.
  • All primary templates are located inside src/views.
  • There is only a single layout defined (default) inside src/layouts
  • The src/components directory hosts all template-specific subcomponents in their own subdirectory.
  • Other extra specific assets are located inside src/assets.
  • All json datas are located inside src/data.
  • All specific helper (normalize) methods are located inside src/UIServices.
  • The src/utils directory contains helper utilities.

💰 Donations

We need you! If you would like to support the further development of this project or the creator of this project, please make a donation using the links below. Your donation is highly appreciated (I love food, coffee and beer 😉). Thank you!

PayPal

  • Donate $5: Thank's for creating this project, here's a cup of tea (or some juice) for you!
  • Donate $10: Wow, I am stunned. Let me take you to the movies!
  • Donate $15: I really appreciate your work, let's grab some lunch!
  • Donate $25: That's some awesome stuff you did right there, dinner is on me!
  • Donate $50: I really really want to support this project, great job!
  • Donate $100: You are the man! This project saved me hours (if not days) of struggle and hard work, simply awesome!
  • Donate $2799: Go buddy, buy that Macbook Pro for yourself!

Patreon

  • Patreon: You can support me on Patreon too!

Of course, you can also choose what you want to donate, all donations are awesome!

👨 Developed By

** Orkhan Rzazade **

Senior software developer with more than 5 years of experience. Passionate about #Asp.Net, #React and #React-Native.

👍 How to Contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

TODO

Order Placement System

  • Basic Frontend
    • Production-ready Frontend (styles etc.)
    • Rewrite to Apollo Client

Order Management System

  • Login
    • Full security with Auth0
  • Basic Frontend
    • Production-ready Frontend (styles etc.)
  • Working Backend

Documentation

  • Guides
    • Development
    • Production
    • Security
    • Deployment

Other

  • Release a public demo

(?) - unsure.

Changelog

Please check out the CHANGELOG.