mirror of
https://github.com/Gabi-Zar/Images-Scrapper-JS.git
synced 2026-04-16 21:26:05 +02:00
Add README.md
This commit is contained in:
57
README.md
Normal file
57
README.md
Normal file
@@ -0,0 +1,57 @@
|
||||
<h1 align="center">Images Scrapper JS</h1>
|
||||
|
||||
<p align="center">
|
||||
<img alt="Stars" src="https://img.shields.io/github/stars/Gabi-Zar/Images-Scrapper-JS?style=flat&color=magenta">
|
||||
<img alt="Forks" src="https://img.shields.io/github/forks/Gabi-Zar/Images-Scrapper-JS?style=flat&color=purple">
|
||||
<img alt="License" src="https://img.shields.io/github/license/Gabi-Zar/Images-Scrapper-JS?style=flat&color=BB0000">
|
||||
<br>
|
||||
<a href="https://github.com/Gabi-Zar"><img title="Developer" src="https://img.shields.io/badge/developer-GabiZar-blue"></a>
|
||||
<img alt="Maintained" src="https://img.shields.io/badge/Maintained-Yes-009900">
|
||||
<img alt="Written In" src="https://img.shields.io/badge/Written%20In-JavaScript-yellow?logo=javascript">
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
A simple web application to search, preview, and download images from multiple providers (currently only supports Bing).
|
||||
|
||||
## Features
|
||||
|
||||
- Search images using a query
|
||||
- Animated background canvas
|
||||
- Express API backend
|
||||
- Configurable settings (provider, offset, max images)
|
||||
- Rate limiting for public hosting
|
||||
|
||||
## Usage
|
||||
|
||||
#### Public instance
|
||||
|
||||
Go to **https://scrapper.gabizar.top** and enjoy.
|
||||
(Rate limiting is enabled on the public instance.)
|
||||
|
||||
#### Deploy your own instance
|
||||
|
||||
1. Install [Git](https://git-scm.com/) and [Node.js](https://nodejs.org)
|
||||
2. Clone the repository `git clone https://github.com/Gabi-Zar/Images-Scrapper-JS`
|
||||
3. Enter the project directory `cd Images-Scrapper-JS`
|
||||
4. Install dependencies `npm install`
|
||||
5. Optional: edit the `.env` file:
|
||||
- `USE_RATE_LIMIT=Boolean`
|
||||
6. Start the application `node main.js`
|
||||
7. Open your browser and go to http://localhost:3000
|
||||
|
||||
## Contributing
|
||||
|
||||
I love every feedback. Just open an issue or make a pull request.
|
||||
|
||||
## License and credit
|
||||
|
||||
This project is licensed under the [GPL-3.0 license](LICENSE).
|
||||
|
||||
> [!CAUTION]
|
||||
> Use this project responsibly.
|
||||
> Please respect copyright and usage rights when downloading images.
|
||||
|
||||
---
|
||||
|
||||
<p align="center">If you like this project, consider giving it a star on GitHub!</p>
|
||||
Reference in New Issue
Block a user