Skip to content

Commit

Permalink
Merge pull request #2158 from AgedRob1n/development
Browse files Browse the repository at this point in the history
Fixed Typos
  • Loading branch information
Shiiyu authored Jan 13, 2024
2 parents a31e2a1 + 6c20d3a commit 4fd69e6
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

Expand All @@ -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

Expand All @@ -56,7 +56,7 @@ if your not sure what code editor to use VS-Code is a great option. Here are som
| 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
{
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ You are free to report bugs or contribute to this project. Just open <a href="..
- <a href="https://redis.io/">Redis</a>
- <a href="https://api.hypixel.net/">Hypixel API Key</a>
- <a href="https://www.nginx.com/">Nginx</a> (Optional for full/production deployment. Helps with web requests and load balancing.)
- <a href="https://letsencrypt.org/">LetsEncrypt</a> (Optional for full/production deployment. Provision free HTTPS certifications.)
- <a href="https://letsencrypt.org/">LetsEncrypt</a> (Optional for full/production deployment. Provision-free HTTPS certifications.)

<h3>Installation</h3>
A more explanatory guide can be found in <a href="/CONTRIBUTING.md">CONTRIBUTING.md</a>

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`.

Expand All @@ -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

0 comments on commit 4fd69e6

Please sign in to comment.