Skip to content

Latest commit

 

History

History
71 lines (56 loc) · 3.83 KB

README.md

File metadata and controls

71 lines (56 loc) · 3.83 KB
Raw

SkyCrypt 🍣

A Hypixel Skyblock Profile Viewer v2

This is the new version of SkyCrypt, a website that provides information about the game Hypixel SkyBlock. This version is built from the ground up to replace the original SkyCrypt for a more modern and maintainable codebase.

Originally inspired by LeaPhant's skyblock-stats.

Development Website: https://cupcake.shiiyu.moe
Production Website: https://sky.shiiyu.moe

Contributing

You are free to report bugs or contribute to this project. Just open Issues or Pull Requests and the team will look into them.

Prerequisites

  • Node.js 20+ and pnpm 9.4+ installed
  • Existing MongoDB and Redis servers to connect to, or Docker for an easier setup
  • A valid Hypixel API Key
    • Obtain a temporary development key on Hypixel's Developer Dashboard
    • A permanent key can be requested on the same page, but are meant for active projects and not sporadic use and require approval
  • Optional for a production deployment:
    • A domain name and a server to host the website
    • Valid SSL certificates for HTTPS
    • A reverse proxy like Nginx for web requests and load balancing

Project Setup

  1. Clone the project and run pnpm i to install the dependencies.
    • If missing pnpm, you can install it with npm i -g pnpm
  2. Copy the .env.example file to a new .env file.
    1. Fill in your Hypixel API Key
    HYPIXEL_API_KEY="KEY"
    1. If you are using the easier Docker setup for MongoDB and Redis, you can leave the default values. Otherwise adjust the connection values to match your setup.
    2. The Discord Webhook URL is optional and can be left alone
  3. Start the MongoDB and Redis servers
    • To do this, run docker compose up -d in the project directory
    • If you are using your own servers, just make sure they are running
  4. Run pnpm run dev to start the website in development mode

Contributing Changes

When contributing changes, the following checks must pass:

  • pnpm run lint to check for code style issues
    • Use pnpm run format to automatically fix formatting issues
  • pnpm run check to run more extensive checks
  • pnpm run build to make sure the project builds correctly

If these checks pass, you can open a pull request with your changes! These checks are also run automatically on pull requests, but it's good to check locally first.

Credits