https://github.com/tsamaya/favicon-crawler

a webservice fetching icons from websites
https://github.com/tsamaya/favicon-crawler

Last synced: 4 days ago
JSON representation

a webservice fetching icons from websites

• Host: GitHub
• URL: https://github.com/tsamaya/favicon-crawler
• Owner: tsamaya
• License: mit
• Created: 2015-06-24T12:01:57.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-07-01T19:29:03.000Z (over 9 years ago)
• Last Synced: 2024-05-02T04:34:34.147Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 172 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# favicon-crawler

A nodeJS webservice fetching icon from websites.

This webservice is using an optional cache system with [redis](http://redis.io). A seven day cache is used before refreshing the cache icon.

## usage

You need to install [Node](http://nodejs.org/) and [Grunt](http://gruntjs.com/) in order to download dependencies and run the server via the command line.

Optionnaly [redis](http://redis.io) is used to cache icons from domains.

1. [Fork and clone the repo](https://help.github.com/articles/fork-a-repo)

2. `cd` into the `favicon-crawler` folder

3. run `npm install` to install dependencies

3. start your local redis datastore

4. run `grunt` to run the server

5. run `curl htpp://127.0.0.1:1515/get?domain=esri.com`

## Requirements

to run the command line tools

* [Node](http://nodejs.org/)

* [Grunt](http://gruntjs.com/)

## Credits

* default Icons are coming from [iconfinder](https://www.iconfinder.com/Vecteezy) by [Vecteezy](http://www.vecteezy.com/free-vector/icons)

##Licensing

Licensed under the MIT License

A copy of the license is available in the repository's [LICENSE](LICENSE) file.