1
mirror of https://github.com/thepeacockproject/Peacock synced 2024-11-22 22:12:45 +01:00
Go to file
Reece Dunham 6245e91624 Initial commit
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>
2022-10-19 21:33:45 -04:00
.idea Initial commit 2022-10-19 21:33:45 -04:00
.vscode Initial commit 2022-10-19 21:33:45 -04:00
.yarn Initial commit 2022-10-19 21:33:45 -04:00
components Initial commit 2022-10-19 21:33:45 -04:00
contractdata Initial commit 2022-10-19 21:33:45 -04:00
packaging Initial commit 2022-10-19 21:33:45 -04:00
patcher Initial commit 2022-10-19 21:33:45 -04:00
resources Initial commit 2022-10-19 21:33:45 -04:00
static Initial commit 2022-10-19 21:33:45 -04:00
webui Initial commit 2022-10-19 21:33:45 -04:00
.cirrus.yml Initial commit 2022-10-19 21:33:45 -04:00
.editorconfig Initial commit 2022-10-19 21:33:45 -04:00
.eslintignore Initial commit 2022-10-19 21:33:45 -04:00
.eslintrc.js Initial commit 2022-10-19 21:33:45 -04:00
.gitattributes Initial commit 2022-10-19 21:33:45 -04:00
.gitignore Initial commit 2022-10-19 21:33:45 -04:00
.nvmrc Initial commit 2022-10-19 21:33:45 -04:00
.prettierignore Initial commit 2022-10-19 21:33:45 -04:00
.yarnrc.yml Initial commit 2022-10-19 21:33:45 -04:00
LICENSE Initial commit 2022-10-19 21:33:45 -04:00
package.json Initial commit 2022-10-19 21:33:45 -04:00
PeacockPatcher.exe Initial commit 2022-10-19 21:33:45 -04:00
readme.md Initial commit 2022-10-19 21:33:45 -04:00
Start Server.cmd Initial commit 2022-10-19 21:33:45 -04:00
THIRDPARTYNOTICES.txt Initial commit 2022-10-19 21:33:45 -04:00
Tools.cmd Initial commit 2022-10-19 21:33:45 -04:00
tsconfig.json Initial commit 2022-10-19 21:33:45 -04:00
webstorm.config.js Initial commit 2022-10-19 21:33:45 -04:00
yarn.lock Initial commit 2022-10-19 21:33:45 -04:00

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.