6245e91624
Co-authored-by: Tino Roivanen <tino.roivanen98@gmail.com> Co-authored-by: Govert de Gans <grappigegovert@hotmail.com> Co-authored-by: Gray Olson <gray@grayolson.com> Co-authored-by: Alexandre Sanchez <alex73630@gmail.com> Co-authored-by: Anthony Fuller <24512050+anthonyfuller@users.noreply.github.com> Co-authored-by: atampy25 <24306974+atampy25@users.noreply.github.com> Co-authored-by: David <davidstulemeijer@gmail.com> Co-authored-by: c0derMo <c0dermo@users.noreply.github.com> Co-authored-by: Jeevat Singh <jeevatt.singh@gmail.com> Signed-off-by: Reece Dunham <me@rdil.rocks> |
||
---|---|---|
.idea | ||
.vscode | ||
.yarn | ||
components | ||
contractdata | ||
packaging | ||
patcher | ||
resources | ||
static | ||
webui | ||
.cirrus.yml | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc.js | ||
.gitattributes | ||
.gitignore | ||
.nvmrc | ||
.prettierignore | ||
.yarnrc.yml | ||
LICENSE | ||
package.json | ||
PeacockPatcher.exe | ||
readme.md | ||
Start Server.cmd | ||
THIRDPARTYNOTICES.txt | ||
Tools.cmd | ||
tsconfig.json | ||
webstorm.config.js | ||
yarn.lock |
The Peacock Project
If you are reading this, you should probably know what you are doing. But If you're a bit less technologically advanced person like the writer of this readme, I will leave you nice and simple readme instructions.
Installation
Install nodejs. Use the Latest version, or the version specifically mentioned here: Version 18
Clone the repository where-ever you wish.
Open Windows terminal AS ADMINISTRATOR
Install yarn, by typing:
corepack enable
Then move to the folder where you cloned the repo to by using:
cd Folder/Path/Here
then install the dependencies by using:
yarn install
Usage
The project is bundled with a server running configuration. Run that when editing the project with the IDE of choice, and it should open. I'm not really sure what should I add here.
Contributing
Writing bug reports is cool. You should do that. Or update this readme whenever it's needed.
Thank you to people who have contributed!
License
Peacock is proprietary, see the license file for more info.