https://github.com/sammers21/pvpqnet

Pvpq.net is a site for WoW PvP players with rankings, ladder data, and tools to improve gameplay and excel in competitive PvP.
https://github.com/sammers21/pvpqnet

backend docker frontend java java20 javascript lucene monogodb mui react reactive-programming reactjs rust rxjava3 telegram vertx virtual-threads website

Last synced: 28 days ago
JSON representation

Pvpq.net is a site for WoW PvP players with rankings, ladder data, and tools to improve gameplay and excel in competitive PvP.

• Host: GitHub
• URL: https://github.com/sammers21/pvpqnet
• Owner: Sammers21
• License: gpl-3.0
• Created: 2023-03-13T21:58:18.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-19T18:47:30.000Z (about 2 months ago)
• Last Synced: 2024-09-26T07:40:10.461Z (about 1 month ago)
• Topics: backend, docker, frontend, java, java20, javascript, lucene, monogodb, mui, react, reactive-programming, reactjs, rust, rxjava3, telegram, vertx, virtual-threads, website
• Language: Java
• Homepage:
• Size: 15.3 MB
• Stars: 13
• Watchers: 2
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Backend build](https://github.com/Sammers21/pvpqnet/actions/workflows/backend-build.yml/badge.svg)](https://github.com/Sammers21/pvpqnet/actions/workflows/backend-build.yml)

[![Frontend build](https://github.com/Sammers21/pvpqnet/actions/workflows/frontend-build.yml/badge.svg)](https://github.com/Sammers21/pvpqnet/actions/workflows/frontend-build.yml)

# pvpq.net

https://pvpq.net is a World of Warcraft PvP data oriented web site which has the following features:

* Leaderboards with player statistics and rankings

* Activity graphs for players for the past several hours

* Support for EU and US regions as well as every pvp bracket

Please consider giving our GitHub project a star if you find it helpful. Your support will help us reach more users and improve our project. Thank you!

# How to run locally

The project consist of two parts: the frontend and the backend.

In order to run the project locally you need to have [Node.js](https://nodejs.org/en/) and [MongoDB](https://www.mongodb.com/) installed as well as a [Battle.net API keys](https://dev.battle.net/).

## Backend

In order to run the backend you need to have:

1. a [MongoDB](https://www.mongodb.com/) instance running

2. [Battle.net API keys](https://dev.battle.net/): client id and secret

3. [Docker](https://www.docker.com/) installed

4. After you have the above you can run the backend with the following commands:

```

docker build -t pvpq-backend .

docker run  -e CLIENT_ID="" -e CLIENT_SECRET="" -e DB_URI="" --name pvpq -d -p9000:9000 pvpq-backend

```

**CLIENT_ID** and **CLIENT_SECRET** are the Battle.net API keys. **DB_URI** is the MongoDB connection string.

The backend will be available at http://localhost:9000. The backend will automatically create the database and populate it with data.

## Frontend

The frontend is a [React](https://reactjs.org/) application which can be run with the following commands:

```

cd frontend

npm install

REACT_APP_API_URL=http://localhost:9000 npm start

```

The frontend will be available at http://localhost:3000