Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gruberb/icon-scout
Go through a list of websites and fetch favicons for them
https://github.com/gruberb/icon-scout
favicon-downloader favicons icons rust
Last synced: 25 days ago
JSON representation
Go through a list of websites and fetch favicons for them
- Host: GitHub
- URL: https://github.com/gruberb/icon-scout
- Owner: gruberb
- License: gpl-3.0
- Created: 2024-09-03T17:29:52.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-12T01:04:47.000Z (about 2 months ago)
- Last Synced: 2024-09-13T09:29:08.856Z (about 2 months ago)
- Topics: favicon-downloader, favicons, icons, rust
- Language: Rust
- Homepage:
- Size: 1.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IconScout
IconScout is a web service which is opening a POST endpoint on `/favicons`, which accepts a `JSON` file with a list of websites
```bash
curl -X POST http://localhost:3000/favicons \
-H "Content-Type: application/json" \
--data-binary @websites.json
```
Example JSON:
```json
[
"https://yahoo.com",
"https://theverge.com",
"https://google.com",
"https://accuweather.com"
]
```
or via `curl`:
```bash
curl -X POST http://localhost:3000/favicons \
-H "Content-Type: application/json" \
--data-raw '["https://google.com","https://yahoo.com","https://theverge.com"]' \
```
It parses the websites, fetches the favicons for them, *and sends back a list of data URIs* as a response:
```json
[
{
"url":"https://mozilla.org",
"data_uri":"data:image/x-icon;base64,AAABAAMAMDA...="
}
]
```
The `data_uri` represents the `favicon` of the given website URL.
### Pre-requirements
Rust has to be installed
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
### Installation
- `git clone [email protected]:gruberb/icon-scout.git`
- `cd icon-scout`
- `cargo build --release`
### Running
Either via `cargo run` inside the `icon-scout` folder, or via the binary: `./target/build/release/icon-scout`
### Example
