cacastats

Web-based application designed to provide a comprehensive scoreboard and player profiles with detailed statistics for a RatMod Clan Arena game server. It allows users to effortlessly access both the overall game statistics and individual player metrics from the last 25 days, enhancing their gaming experience.

Requirement

Node.js ≥ 8.3.0

Python ≥ 3.0.0

Installation

To run the project locally:

Clone the repository

git clone https://github.com/uruam/cacastats.git

Navigate to the server directory

cd cacastats/server

Install server dependencies

npm install

Create a .env file in the server directory and add the following environment variables:

• PORT: Specifies the port on which the app will run.
• API_URL: Specifies the location of the matches.json file.
• SERVERNAME: Specifies the name of your server in the matches.json file.
• GAMETYPE: Specifies the game type in the matches.json file.

For example:

PORT=3000
API_URL=https://my-rat-server.com/
SERVERNAME=MY-RAT-SERVER-CA
GAMETYPE=8

Start the server

npm run start

Navigate to the client folder

cd ../client

Install dependencies

npm install

Automatically transcompile and bundle the client code during development whenever source files change

npm run dev

Transcompile and bundle the client code for production deployment

npm run build

Usage

The server will be running locally on port 3000. Access the application by opening a web browser and going to http://localhost:3000.

Code Style

The project utilizes ESLint and Prettier for code linting and formatting. While these tools are integrated into the build process for the client using webpack, the server code needs to be linted separately.

Steps:

After editing the server code, navigate to the server directory

cd server

Run ESLint to check for any code style violations

npm run lint

Resolve any reported issues based on ESLint's recommendations

Credits

icons: RatMod authors

oaquery: Rodent Control

License

This project is licensed under the GPL-2.0 license.