Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/judahpaul16/www-clear-badge-cache
Website for the clear-badge-cache repo. Built with Go, HTMX, & HyperScript.
https://github.com/judahpaul16/www-clear-badge-cache
badges cache docker golang htmx hyperscript shields template
Last synced: about 2 months ago
JSON representation
Website for the clear-badge-cache repo. Built with Go, HTMX, & HyperScript.
- Host: GitHub
- URL: https://github.com/judahpaul16/www-clear-badge-cache
- Owner: judahpaul16
- License: gpl-3.0
- Created: 2024-04-29T02:09:11.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-16T20:10:30.000Z (8 months ago)
- Last Synced: 2024-06-19T11:30:42.482Z (7 months ago)
- Topics: badges, cache, docker, golang, htmx, hyperscript, shields, template
- Language: HTML
- Homepage: https://clear-badge-cache.com
- Size: 11.9 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Clear Badge Cache Web Interface 🧹✨
[](https://go.dev/dl/)
[](https://goreportcard.com/report/github.com/judahpaul16/www-clear-badge-cache)
[](LICENSE)
[](https://clear-badge-cache.com/)
[](https://hub.docker.com/r/judahpaul/www-clear-badge-cache)
[](https://github.com/judahpaul16/www-clear-badge-cache/actions)
[Clear-Badge-Cache.com](https://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](https://github.com/judahpaul16/clear-badge-cache) 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 🚀
```bash
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](https://go.dev/dl/)
- [HTMX](https://htmx.org/)
- [HyperScript](https://hyperscript.org/)
- [Docker (optional)](https://www.docker.com/)
### Installation 🛠
1. Clone the repository:
```bash
git clone https://github.com/judahpaul16/www-clear-badge-cache.git
```
2. Navigate to the project directory:
```bash
cd www-clear-badge-cache
```
3. Run the app:
*Linux/Mac*
```bash
./build-scripts/build.sh # builds and runs docker container
```
*Windows*
```bash
./build-scripts/build.bat # builds and runs docker container
```
*If you would prefer not to use Docker run:*
```bash
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:
```bash
go build -o www-clear-badge-cache
```
### Running 🏃
After building, you can run the application directly:
```bash
./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.