README.md

Hypixel Rust Backend  

Set Up

Prerequisites

• Rust
• Cargo
• Hypixel API Key

Steps

• Clone the repository
• Rename the .example_env file to .env and fill out required fields OR set required fields using environment variables
• Run cargo run --release (may take some time to build)
• Use the API!

Required Configuration Fields

• BASE_URL: Base address to bind to (e.g. 0.0.0.0)
• PORT: Port to bind to (e.g. 8000)
  • Online hosts will automatically set this
• API_KEY: Your Hypixel API key

Usage

Endpoints

• /key
• /boosters
• /leaderboards
• /punishmentstats
• /player
  • username
  • uuid
• /guild
  • id
  • name
  • player
  • username
• /counts
• /status
  • username
  • uuid
• /recentGames
  • username
  • uuid
• /skyblock/profiles
  • username
  • uuid
• /skyblock/profile
  • profile
• /skyblock/bingo
  • username
  • uuid
• /skyblock/news
• /skyblock/auction
  • player
  • uuid
  • profile
  • username
• /skyblock/auctions
  • page
• /skyblock/auctions_ended
• /skyblock/bazaar
• /skyblock/firesales
• /resources/{resource}/{sub_resource}

Documentation & Examples

• Coming soon

Free Hosting

Deploy On Railway

Deploy On Gigalixir

Steps to deploy on Gigalixir:

1. Clone repository
2. Install gigalixir CLI: pip3 install gigalixir
3. Sign up: gigalixir signup
4. Create app: gigalixir create -n NAME
5. Set environment variables: gigalixir config:set key=value
6. Deploy app: git push gigalixir
7. Acess at https://NAME.gigalixirapp.com/

License & Contributing

Licensed under either of Apache License, Version 2.0 or MIT license at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this repository by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Note: this is still a work in progress