WoWAnalyzer
WoWAnalyzer copied to clipboard
[Docs] Revise/Update Project Setup Instructions
Go through our getting started / setup instructions, ensure that everything is still accurate, and improve presentation
- [ ] Verify setup instructions on Windows (revising if needed)
- [ ] Update README (if needed)
Setup instructions work for Windows.
I think I didn't have any issues on Linux either (Manjaro if it makes any difference)
Maybe a bit of feedback before you waste time;
The reference to making a fork could be 'automized' to https://github.com/WoWAnalyzer/WoWAnalyzer/fork
I recently cloned the project on both Windows and Mac without issues. Followed the steps in the readme.md;
Windows 10 64-bit
- Already had Git installed via the link (personal preference). but its easy enough to install.
- Installed Node.js version 16.16.0 Since LTS was recommended.
- Installed yarn as described in the installation process on their page.
MacOS (12) Monterey M1 chip
- Already had git installed, modern MacOS and linux systems come with git by default.
- Installed Node.js via
nvm
(Node Version Manager). Its alot easier imo and allows for multiple node installations. I had this installed viabrew
**$ nvm install 16 && nvm alias default 16
** We can make a file that automatiscly detects the supported version for nvm by simply creating a.nvmrc
file with the recommended version in it. eg16.17.0
- Installed yarn as described in the installation process on their page.
The only thing I'd consider is maybe making the instructions clearer. Right now the instructions are written kind of like a prose, which makes it a little harder to follow. Something like ordered list of instructions, short and right to the point, like
- Make sure you have prerequisities - git, Node.js, Yarn
- Fork the repository and clone it locally
- Inside the cloned folder, run
yarn
- Copy
.env.local.example
into.env.local
and fill in your WCL key:- instructions on how to do it
- Run
yarn start
- ???
- Profit!