Overview:
Elite Website is a tool designed for Hypixel Skyblock players to check their farming skill/weight. The website is still under development but offers a useful feature for players to assess their progress in the game. It works in conjunction with a backend API, which requires its own setup. The website provides instructions for installation and usage, including setting up the necessary environment variables and creating a production version of the app.
Features:
- Checking player’s farming skill/weight in Hypixel Skyblock
- Integration with a backend API for data retrieval
- Customizable environment variables for local development
- Production build and deployment options
Installation:
To install and run the Elite Website, follow these steps:
- Download the code from the repository.
- Open the project and run
pnpm ito install the dependencies. - Create a copy of
.env.example, rename it to.env, and fill out all the fields with the relevant values.DISCORD_CLIENT_SECRETandPUBLIC_DISCORD_CLIENT_IDcan be obtained from https://discord.com/developers/applications after creating a new application.- Other values in the
.envfile can be left as-is for local development.
- Add redirect URIs in the developer dashboard of the Discord application for authentication to work.
- Make a copy of the updated
.envfile and rename it to.env.production. - Run the website in dev mode using the provided command.
- To create a production version of the app, edit the
.env.productionfile to use the desired port. - Ensure that the redirect URI for port 3000 is added in the Discord application settings.
- Start the production build using the provided command.
- Access the site at http://localhost:3000/.
Note: To deploy the site on a domain name, further configuration using other tools like nginx forwarding is required.
Summary:
Elite Website is an in-development tool for Hypixel Skyblock players to track their farming skill/weight. It offers useful features and requires the setup of a backend API. The installation process is provided along with instructions for both local development and production build deployment.