Glee-Mirror/README.md

Glee Mirror

Requirements

For Running (Production)

• Docker Engine:
  • Linux
  • macOS (Homebrew, without Docker Desktop)
  • Windows (WSL2, without Docker Desktop)

For Building (Development)

• Bun
• Docker Engine:
  • Linux
  • macOS (Homebrew, without Docker Desktop)
  • Windows (WSL2, without Docker Desktop)
• Code Editor:
  • VSCodium
  • Sublime Text (Astro Package)
  • Pulsar (Astro Package)

Runnning (Production)

Clone the repository, then make changes the site that is needed, especially swapping out all sample logos:

git clone https://ark.sudovanilla.org/Korbs/Glee-Mirror/
cd ./Glee-Mirror/

Then, once you're done with making changes to the site, run the Docker Compose file:

docker compose up -d

You have the freedom to change the 2000 port to whatever you want. Keep the 4321 port as-is.

Note

You may need to use sudo depending on your Docker Engine setup.

Building (Development)

Clone the repository:

git clone https://ark.sudovanilla.org/Korbs/Glee-Mirror/
cd ./Glee-Mirror/

With Bun, install the dependencies:

bun install

Run:

bun dev

The site should be running locally, on port 4321.

---

Configuration

You can update the menu items in the header and bottom footer with the configuration file that is already provided. It's the config.json file, that uses an array setup.

You'll need to manually update the upper footer links in the footer.astro file still.

Theming

By default, the template supports light and dark mode. It switches depending on the end-user's setup, this is up to what mode the user has their website browser set to.

You need to accommadate this with your logo, as it may not appear correctly for one of the themes.

This is why the footer has two versions of the sample logo.

---

Credits

Logos

All logos are placeholders provided by https://logoipsum.com/ (License).

Icons

All icons are supplied by Iconoir

---

License

MIT License NON-AI

Copyright 2025 SudoVanilla

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

In addition, the following restrictions apply:

1. The Software and any modifications made to it may not be used for the purpose of training or improving machine learning algorithms,
including but not limited to artificial intelligence, natural language processing, or data mining. This condition applies to any derivatives,
modifications, or updates based on the Software code. Any usage of the Software in an AI-training dataset is considered a breach of this License.

2. The Software may not be included in any dataset used for training or improving machine learning algorithms,
including but not limited to artificial intelligence, natural language processing, or data mining.

3. Any person or organization found to be in violation of these restrictions will be subject to legal action and may be held liable
for any damages resulting from such use.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---