Skip to content

azerothcore/wow-statistics

Repository files navigation

WoW Statistics

This repository is a collection of React components to display useful information about the population as charts.

WoW Statistics

Internals

This project was bootstrapped with Create React App.

The chart was done with AmChart 4 and inspired by this example.

The application was safely typed with TypeScript.

Before running

See .env.example before running the application (at the moment we don't support a local profile, but you can mock it yourself using this mocked json)

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

How to contribute

  • Required NPM 6.x and Node 12.x or 14.x installed
  • The recommended IDE: WebStorm or Visual Studio Code
  • Follow the conventional commits guideline
  • Commit messages are formatted with commit-lint
  • Code is formatted with Prettier
  • Open pull-requests