WoWAnalyzer is a tool to help you analyze and improve your World of Warcraft raiding performance through various relevant metrics and gameplay suggestions.
This guide is an excellent introduction and explains all the jargon we may use: https://medium.com/clarifai-champions/99-pr-oblems-a-beginners-guide-to-open-source-abc1b867385a
If you ever get stuck or want to have a chat, join us on our Discord server. We love to hear what you're (going to be) working on!
First make sure you have the following:
- git
- Optional: Get a UI such GitHub Desktop TortoiseGit
- Node.js. We recommend the LTS version.
- pnpm
Now you need to pull a copy of the codebase onto your computer. Make a fork of the repo by clicking the Fork button at the top of this page. Next, click the green button Clone or download and copy your Clone with HTTPS URL, and then run the command git clone <paste link>. This will take a minute.
When cloning finishes, open a command window to the source and run the command pnpm install.
Once all that's done you're ready to fire up the development server! Just run the command pnpm start in the project root. This should open up your local version of WoWAnalyzer in the browser.
At this point you can poke around and start making changes, or head over to the wiki for more information.
If you are getting an error about a missing module or library you might have to update your dependencies. Run pnpm install. Make sure there's no running pnpm start or pnpm test when you do as they might lock files.
See the contributing guidelines for further information.