From 1e123531b506239a381def8af62458f42b8673a5 Mon Sep 17 00:00:00 2001 From: Sammers21 Date: Wed, 19 Jul 2023 14:12:56 +0300 Subject: [PATCH] back to old readme --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 92d5bd98..efc2fcee 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,24 @@ [![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 comprehensive website that provides real-time updates on ladder activity and PvP ladder data for World of Warcraft's PvP segment. It offers detailed information on player rankings, win rates, and other statistics, as well as helpful resources and tools for players looking to improve their PvP skills. Whether you're a seasoned veteran or a beginner, Pvpq.net is the ultimate resource for all things PvP in World of Warcraft. +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 -One of the standout features of Pvpq.net is its ability to show ladder activity and PvP ladder data for every PvP bracket. This includes 2v2, 3v3, shuffle, and rated battlegrounds. Players can easily track their progress and see where they stand in the rankings for their chosen 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! -In addition to ladder activity and PvP ladder data, Pvpq.net also has a section dedicated to showing the current in-game meta. This is incredibly helpful for players who want to stay up-to-date with the latest trends and strategies in World of Warcraft's PvP segment. By keeping an eye on the meta, players can adjust their playstyle and team composition to stay competitive. +# 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/). -Another great feature of Pvpq.net is its player profiles section. Here, players can view detailed information about other players, including their win rates, favorite classes, and more. This can be incredibly helpful for players who want to learn from others or find new teammates to play with. - -Overall, Pvpq.net is an incredibly useful website for anyone interested in World of Warcraft's PvP segment. With its real-time updates, detailed statistics, and helpful resources, it's the ultimate resource for players looking to improve their PvP skills and climb the ranks. +## 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 ``` @@ -24,4 +33,4 @@ cd frontend npm install REACT_APP_API_URL=http://localhost:9000 npm start ``` -The frontend will be available at http://localhost:3000 +The frontend will be available at http://localhost:3000 \ No newline at end of file