Merge pull request #19 from SkyCryptWebsite/dev

bump prod

Author: DuckySoLucky

NotEnoughUpdates-REPO

@@ -0,0 +1,194 @@
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: light)" srcset="static/img/logo_black.avif">
+    <img alt="SkyCrypt" height="96px" src="https://github.com/SkyCryptWebsite/SkyCrypt-Frontend/raw/dev/static/img/logo.avif">
+  </picture>
+</p>
+<h1 align="center">SkyCrypt Backend</h1>
+<h3 align="center">A Hypixel SkyBlock Profile Viewer</h3>
+
+<p align="center">
+  <a href="https://www.patreon.com/shiiyu"><img alt="Sponsor" src="https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#white" /></a>
+  &nbsp;
+  <a href="https://github.com/SkyCryptWebsite/SkyCrypt-Backend/stargazers"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/SkyCryptWebsite/SkyCrypt-Backend?style=for-the-badge" /></a>
+</p>
+
+A high-performance Go backend API for [SkyCrypt](https://github.com/SkyCryptWebsite/SkyCrypt), providing statistics and data processing for Hypixel SkyBlock players.
+
+Originally inspired by [LeaPhant's skyblock-stats](https://github.com/LeaPhant/skyblock-stats).
+
+**Website**: https://sky.shiiyu.moe \
+**Development Website**: https://cupcake.shiiyu.moe
+
+**Frontend**: [SkyCrypt-Frontend](https://github.com/SkyCryptWebsite/SkyCrypt-Frontend)
+
+## Table of Contents
+
+- [Requirements](#requirements)
+- [Installation](#installation)
+  - [System Dependencies](#system-dependencies)
+  - [Go Installation](#go-installation)
+  - [Redis Installation](#redis-installation)
+  - [MongoDB Installation](#mongodb-installation)
+- [Configuration](#configuration)
+- [Development](#development)
+- [Common Issues](#common-issues)
+
+## Requirements
+
+- Go 1.25.1 or later
+- Redis 7.0 or later
+- MongoDB 6.0 or later
+- Git (for submodule initialization)
+
+## Installation
+
+The following instructions are written for Arch Linux. Adjust package manager commands accordingly for other distributions.
+
+### System Dependencies
+
+Update your system and install essential build tools:
+
+```bash
+sudo pacman -Syu
+sudo pacman -S base-devel git
+```
+
+### Go Installation
+
+Install Go from the official Arch Linux repositories:
+
+```bash
+sudo pacman -S go
+```
+
+Verify the installation:
+
+```bash
+go version
+```
+
+### Redis Installation
+
+Install Redis:
+
+```bash
+sudo pacman -S redis
+```
+
+Enable and start the Redis service:
+
+```bash
+sudo systemctl enable redis
+sudo systemctl start redis
+```
+
+Verify Redis is running:
+
+```bash
+redis-cli ping
+```
+
+Expected output: `PONG`
+
+### MongoDB Installation
+
+Install MongoDB from the AUR. Using an AUR helper such as `yay`:
+
+```bash
+yay -S mongodb-bin
+```
+
+Alternatively, build from source:
+
+```bash
+git clone https://aur.archlinux.org/mongodb-bin.git
+cd mongodb-bin
+makepkg -si
+```
+
+Enable and start the MongoDB service:
+
+```bash
+sudo systemctl enable mongodb
+sudo systemctl start mongodb
+```
+
+Verify MongoDB is running:
+
+```bash
+mongosh --eval "db.runCommand({ ping: 1 })"
+```
+
+## Configuration
+
+### Environment Variables
+
+Create a `.env` file in the project root directory. Use `.env.example` as a template:
+
+```bash
+cp .env.example .env
+```
+
+Edit the `.env` file with your configuration:
+
+```dotenv
+HYPIXEL_API_KEY=""
+DISCORD_WEBHOOK=""
+DEV="true"
+ENABLE_ARMOR_HEX="false"
+MONGO_URI="mongodb://localhost:27017"
+MONGO_DB_NAME="SkyCrypt"
+```
+
+### Environment Variable Reference
+
+| Variable | Description | Default | Required |
+|----------|-------------|---------|----------|
+| `HYPIXEL_API_KEY` | Your Hypixel API key. Obtain from [Hypixel Developer Portal](https://developer.hypixel.net/) | - | Yes |
+| `DISCORD_WEBHOOK` | Discord webhook URL for error notifications and startup messages | - | No |
+| `DEV` | Enable development mode. Set to `true` for local development | `false` | No |
+| `ENABLE_ARMOR_HEX` | Enable hexadecimal armor color support | `false` | No |
+| `MONGO_URI` | MongoDB connection URI | `mongodb://localhost:27017` | No |
+| `MONGO_DB_NAME` | MongoDB database name | `SkyCrypt` | No |
+| `REDIS_HOST` | Redis server hostname | `localhost` | No |
+| `REDIS_PORT` | Redis server port | `6379` | No |
+| `REDIS_PASSWORD` | Redis authentication password | - | No |
+
+## Development
+
+Clone the repository with submodules:
+
+```bash
+git clone --recurse-submodules https://github.com/SkyCryptWebsite/SkyCrypt-Backend.git
+cd SkyCrypt-Backend
+```
+
+If you have already cloned the repository without submodules:
+
+```bash
+git submodule update --init --recursive
+```
+
+Download Go dependencies:
+
+```bash
+go mod download
+```
+
+Run the application:
+
+```bash
+go run main.go
+```
+
+## Common Issues
+
+### Submodule Not Initialized
+
+If the `NotEnoughUpdates-REPO` directory is empty:
+
+```bash
+git submodule update --init --recursive
+```
+

README.md

@@ -9,7 +9,7 @@ require (
 	github.com/gofiber/fiber/v2 v2.52.9
 	github.com/joho/godotenv v1.5.1
 	github.com/swaggo/swag/v2 v2.0.0-rc4
-	github.com/yokeTH/gofiber-scalar v0.1.1
+	go.mongodb.org/mongo-driver v1.17.6
 )
 
 // replace github.com/DuckySoLucky/SkyCrypt-Types => ../SkyCrypt-Types
@@ -35,15 +35,10 @@ require (
 	github.com/go-openapi/jsonpointer v0.22.1 // indirect
 	github.com/go-openapi/jsonreference v0.21.2 // indirect
 	github.com/go-openapi/spec v0.22.0 // indirect
-	github.com/go-openapi/swag v0.25.1 // indirect
-	github.com/go-openapi/swag/cmdutils v0.25.1 // indirect
 	github.com/go-openapi/swag/conv v0.25.1 // indirect
-	github.com/go-openapi/swag/fileutils v0.25.1 // indirect
 	github.com/go-openapi/swag/jsonname v0.25.1 // indirect
 	github.com/go-openapi/swag/jsonutils v0.25.1 // indirect
 	github.com/go-openapi/swag/loading v0.25.1 // indirect
-	github.com/go-openapi/swag/mangling v0.25.1 // indirect
-	github.com/go-openapi/swag/netutils v0.25.1 // indirect
 	github.com/go-openapi/swag/stringutils v0.25.1 // indirect
 	github.com/go-openapi/swag/typeutils v0.25.1 // indirect
 	github.com/go-openapi/swag/yamlutils v0.25.1 // indirect
@@ -60,20 +55,15 @@ require (
 	github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect
 	github.com/skeema/knownhosts v1.3.1 // indirect
 	github.com/sv-tools/openapi v0.2.1 // indirect
-	github.com/swaggo/fiber-swagger v1.3.0 // indirect
-	github.com/swaggo/files v1.0.1 // indirect
-	github.com/swaggo/swag v1.16.6 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	github.com/xanzy/ssh-agent v0.3.3 // indirect
 	github.com/xdg-go/pbkdf2 v1.0.0 // indirect
 	github.com/xdg-go/scram v1.1.2 // indirect
 	github.com/xdg-go/stringprep v1.0.4 // indirect
 	github.com/youmark/pkcs8 v0.0.0-20240726163527-a2c0da244d78 // indirect
-	go.mongodb.org/mongo-driver v1.17.6 // indirect
 	go.yaml.in/yaml/v3 v3.0.4 // indirect
 	golang.org/x/arch v0.21.0 // indirect
 	golang.org/x/crypto v0.43.0 // indirect
-	golang.org/x/mod v0.29.0 // indirect
 	golang.org/x/net v0.46.0 // indirect
 	golang.org/x/sync v0.17.0 // indirect
 	golang.org/x/tools v0.38.0 // indirect
@@ -93,10 +83,9 @@ require (
 	github.com/mattn/go-colorable v0.1.14 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mattn/go-runewidth v0.0.19 // indirect
-	github.com/rivo/uniseg v0.4.7 // indirect
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
 	github.com/valyala/fasthttp v1.67.0 // indirect
-	golang.org/x/exp v0.0.0-20250718183923-645b1fa84792
+	golang.org/x/exp v0.0.0-20250718183923-645b1fa84792 // indirect
 	golang.org/x/sys v0.37.0 // indirect
 	golang.org/x/text v0.30.0
 )