creations/profilePage
1
2
Fork 3
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

add to readme
All checks were successful
Code quality checks / biome (push) Successful in 9s
Details

Browse source
This commit is contained in:
creations 2025-05-02 13:15:30 -04:00
parent 2330953c33
commit dbe894a568
Signed by: creations
GPG key ID: 8F553AA4320FC711
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -2,6 +2,9 @@
A cool little web app that shows your Discord profile, current activity, and more. Built with Bun. A cool little web app that shows your Discord profile, current activity, and more. Built with Bun.
# Preview
https://creations.works
--- ---
## Requirements ## Requirements
@ -96,6 +99,19 @@ Make sure the `.env` file is configured correctly before starting the container.
--- ---
## Routes
These are the main public routes exposed by the server:
| Route | Description |
|---------------|-----------------------------------------------------------------------------|
| `/` | Loads the profile page for the default Discord user defined in `.env` (`LANYARD_USER_ID`) |
| `/[id]` | Loads the profile page for a specific Discord user ID passed in the URL |
> Example: `https://creations.works/209830981060788225` shows the profile of that specific user.
---
## License ## License
[BSD 3](LICENSE) [BSD 3](LICENSE)