www-clear-badge-cache

README

Clear Badge Cache Web Interface 🧹✨

Clear-Badge-Cache.com is a web-based tool designed to make it easier to clear the cache for GitHub badge images by providing a simple and intuitive user interface. This tool is based on the Clear Badge Cache CLI tool but adds a user-friendly web interface for the same functionality.

Features 🌟

• Simple User Interface: Just enter the URL of the badge you need to clear, and the cache will be cleared without needing to handle CLI operations.
• Built with Go, HTMX & HyperScript: Leveraging modern technologies for a lightweight and responsive experience.

Quick Start 🚀

docker rm -f www-clear-badge-cache
docker pull judahpaul16/www-clear-badge-cache:latest
docker run -d -p 8080:8080 judahpaul16/www-clear-badge-cache:latest

Prerequisites 📋

• Go
• HTMX
• HyperScript
• Docker (optional)

Installation 🛠

1. Clone the repository:

   git clone https://github.com/judahpaul16/www-clear-badge-cache.git
   

2. Navigate to the project directory:

   cd www-clear-badge-cache
   

3. Run the app:

   Linux/Mac

   ./build-scripts/build.sh # builds and runs docker container
   

   Windows

   ./build-scripts/build.bat # builds and runs docker container
   

   If you would prefer not to use Docker run:

   air
   

   This will start the web server on localhost:8080.

Usage 🖥️

• Open a web browser and go to http://localhost:8080.
• You will see a form to input the URL of the badge you wish to clear from the cache.
• Enter the URL and submit the form to clear the cache.

Building 🔨

To build an executable, run:

go build -o www-clear-badge-cache

Running 🏃

After building, you can run the application directly:

./www-clear-badge-cache

Contributing 🤝

Contributions are welcome! Feel free to open pull requests or issues to improve the functionality or documentation.

License 📝

Distributed under the GNU GPL-3 License. See LICENSE for more information.