skyblock.bingo

View your Hypixel Skyblock bingo stats
Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Acknowledgments

About

• View your global bingo ranking
• View your completed goals for this month's bingo event
• View a guide on how to complete your remaining goals
• View a leaderboard of the top 100 bingo players

Getting Started

Prerequisites

• Node.js
• Go
• Redis

Installation

1. Get a Hypixel API Key at developer.hypixel.net
2. Clone the repo

   git clone https://github.com/awesomepandapig/skyblock.bingo.git

3. Enter the client directory

   cd client

4. Install NPM packages

   npm install

5. Enter your API Key in .env.local

   API_KEY='YOUR_API_KEY';

6. Enter the server direcory

   cd ../server

7. Enter your API Key in .env

   API_KEY='YOUR_API_KEY';

Running

1. Run the client

   cd client
   npm run build && npm start

2. Run the server

   cd server
   redis-server --daemonize yes
   go run index.go

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

Acknowledgments

• Bingo guide provided by Bingo Brewers
• Minecraft usernames provided by Mojang
• Minecraft head images provided by Crafatar
• This product is not affiliated or endorsed by Hypixel