From 706de5fdba15c2f1bcde6b21d9434bb5dbf34f65 Mon Sep 17 00:00:00 2001 From: Shawn Grove <126805381+AgedRob1n@users.noreply.github.com> Date: Mon, 8 Jan 2024 17:53:02 -0600 Subject: [PATCH 1/4] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 043f8b8478..b34f9f18db 100644 --- a/README.md +++ b/README.md @@ -27,12 +27,12 @@ You are free to report bugs or contribute to this project. Just open Redis - Hypixel API Key - Nginx (Optional for full/production deployment. Helps with web requests and load balancing.) -- LetsEncrypt (Optional for full/production deployment. Provision free HTTPS certifications.) +- LetsEncrypt (Optional for full/production deployment. Provision-free HTTPS certifications.)

Installation

A more explanatory guide can be found in CONTRIBUTING.md -Clone the project and and run `pnpm i` to install the dependencies. +Clone the project and run `pnpm i` to install the dependencies. Now open `credentials.json` and enter a valid Hypixel API Key. You can obtain one by going to `developer.hypixel.net/dashboard` and clicking `Create API Key`. From cbab78381f61e5d9b457477e06422521531eb054 Mon Sep 17 00:00:00 2001 From: Shawn Grove <126805381+AgedRob1n@users.noreply.github.com> Date: Mon, 8 Jan 2024 17:57:50 -0600 Subject: [PATCH 2/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4d9db6224f..e22c57fca1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -## Contributing to the SkyCrypt +## Contributing to SkyCrypt -Before contributing to SkyCrypt, make sure you install the development environment first. If you have trouble building SkyCrypt or have any development questions, please don't hesistate to contact us on [Discord](https://discord.gg/cNgADv2kEQ)! +Before contributing to SkyCrypt, make sure you install the development environment first. If you have trouble building SkyCrypt or have any development questions, please don't hesitate to contact us on [Discord](https://discord.gg/cNgADv2kEQ)! ### Prerequisite Software @@ -13,9 +13,9 @@ Before contributing to SkyCrypt, make sure you install the development environme ### Alternative Installations - Redis - - On windows, you can get redis through [this link](https://github.com/MicrosoftArchive/redis/releases/tag/win-3.2.100). Download the zip, extract it, and run it by double clicking `redis-server.exe` + - On Windows, you can get Redis through [this link](https://github.com/MicrosoftArchive/redis/releases/tag/win-3.2.100). Download the zip, extract it, and run it by double clicking `redis-server.exe` - MongoDB - - Instead of installing Mongo on your own device, you can use the free MongoDB Atlas program [here](https://www.mongodb.com/). It does require an account, but it is free. + - Instead of installing Mongo on your device, you can use the free MongoDB Atlas program [here](https://www.mongodb.com/). It does require an account, but it is free. ### Getting Started @@ -31,13 +31,13 @@ Before contributing to SkyCrypt, make sure you install the development environme - Some operating systems may require extra dependencies, such as [node-canvas](https://github.com/Automattic/node-canvas/wiki) 3. Go to `developer.hypixel.net/dashboard`. Click `Create API Key` and copy the result. 4. Open `credentials.json` and input your Hypixel API key into the `hypixel_api_key` field. -5. In the `dbUrl` field, input your MongoDB url. In the `dbName` field, input the name of the database you would like to use. -6. (optional) If you are not using the default Redis port or you are using Redis remotely, you can configure the Redis URL with the `redisUrl` field in `credentials.json`. Also `discord_webhook` if you want to send error remotely, useful in production to detect bugs. -7. Making sure your Mongo and Redis instances are running, run `pnpm start` for production or `pnpm dev` for development in the project directory. You should now be able to access the site at http://localhost:32464/ +5. In the `dbUrl` field, input your MongoDB URL. In the `dbName` field, input the name of the database you would like to use. +6. (optional) If you are not using the default Redis port or you are using Redis remotely, you can configure the Redis URL with the `redisUrl` field in `credentials.json`. Also `discord_webhook` if you want to send errors remotely, useful in production to detect bugs. +7. Make sure your Mongo and Redis instances are running, run `pnpm start` for production or `pnpm dev` for development in the project directory. You should now be able to access the site at http://localhost:32464/ ### VS-Code -if your not sure what code editor to use VS-Code is a great option. Here are some recommendations for using VS-Code to work on SkyCrypt. +If you're not sure what code editor to use VS-Code is a great option. Here are some recommendations for using VS-Code to work on SkyCrypt. #### Recommended Extensions From 1196c049117dbf1df1d612627ab2f2377d9c316a Mon Sep 17 00:00:00 2001 From: Shawn Grove <126805381+AgedRob1n@users.noreply.github.com> Date: Mon, 8 Jan 2024 17:58:31 -0600 Subject: [PATCH 3/4] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e22c57fca1..a7b83de4c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,7 +56,7 @@ If you're not sure what code editor to use VS-Code is a great option. Here are s | JavaScript › Validate: Enable | unchecked | | Files: Eol | \n | -you can also apply all these settings by creating a file called `settings.json` inside `.vscode` and copying the following into it: +You can also apply all these settings by creating a file called `settings.json` inside `.vscode` and copying the following into it: ```json { From 6c20d3a3b90386aba479fac85d64fda96330027a Mon Sep 17 00:00:00 2001 From: Shawn Grove <126805381+AgedRob1n@users.noreply.github.com> Date: Mon, 8 Jan 2024 17:59:44 -0600 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b34f9f18db..49ce2e8573 100644 --- a/README.md +++ b/README.md @@ -50,5 +50,5 @@ You can now run `pnpm start` to start it. You will be able to access the site on - [Vanilla+](https://hypixel.net/threads/2147652) by TBlazeWarriorT - [Worlds and Beyond](https://hypixel.net/threads/3597207) by Skeletony\_ - [Default Minecraft Textures](https://www.minecraft.net/) by Mojang -- **Player Heads**: [SkyBlock](https://hypixel.net/forums/skyblock.157/) by Hypixel. +- **Player Heads**: [SkyBlock](https://hypixel.net/forums/skyblock.157/) by Hypixel - **Original Site**: [sky.lea.moe](https://sky.lea.moe/) by LeaPhant