add redis, game icons and fix readme
Some checks failed
Code quality checks / biome (push) Failing after 10s

This commit is contained in:
creations 2025-04-20 14:39:15 -04:00
parent 245215265a
commit 6d46ef48d0
Signed by: creations
GPG key ID: 8F553AA4320FC711
7 changed files with 153 additions and 21 deletions

View file

@ -2,12 +2,20 @@
A cool little web app that shows your Discord profile, current activity, and more. Built with Bun and EJS.
## Prerequisite: Lanyard Backend
## Requirements
This project relies on the following services to function correctly:
### 1. Lanyard Backend
This project depends on a self-hosted or public [Lanyard](https://github.com/Phineas/lanyard) instance for Discord presence data.
Make sure Lanyard is running and accessible before using this profile page.
### 2. Redis Instance
A Redis-compatible key-value store is required for caching third-party data (e.g., SteamGridDB icons).
We recommend using [Dragonfly](https://www.dragonflydb.io/) as a high-performance drop-in replacement for Redis.
---
## Getting Started
@ -34,9 +42,10 @@ cp .env.example .env
|--------------------|--------------------------------------------------|
| `HOST` | Host to bind the Bun server (default: `0.0.0.0`) |
| `PORT` | Port to run the server on (default: `8080`) |
| `REDIS_URL` | Redis connection string |
| `LANYARD_USER_ID` | Your Discord user ID |
| `LANYARD_INSTANCE` | Lanyard WebSocket endpoint URL |
| `BADGE_API_URL` | Uses the [badge api](https://git.creations.works/creations/badgeAPI) only required if you want to use badges
| `BADGE_API_URL` | Uses the [badge api](https://git.creations.works/creations/badgeAPI) only required if you want to use badges |
#### Optional Lanyard KV Vars (per-user customization)