Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beterrabaa/amz_scrap_ch
https://github.com/beterrabaa/amz_scrap_ch
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/beterrabaa/amz_scrap_ch
- Owner: beterrabaA
- Created: 2024-02-23T23:19:12.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-02-24T00:37:19.000Z (9 months ago)
- Last Synced: 2024-02-24T01:28:51.170Z (9 months ago)
- Language: JavaScript
- Size: 26.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Scrapper Challenge
This is a simple scrapper that gets the title, description and image of a amazon website.It has backend and frontend. The backend is made with node and the frontend is made with simple (HTML,Javacript,CSS).
## Backend
The backend is made with node and it uses the following libraries:
- express
- cheerio
- axios
## Frontend
The frontend is made with simple HTML, Javascript and CSS. It uses the following libraries:
- Ajax (Jquery)
- Bootstrap
## How to run
Can be runned in two ways:
### Using bash commands
```bash
bash ./run.sh
```
### Manually
To run the backend you need to have node installed. Then you can run the following commands:
```bash
cd backend
npm install
npm start
```
To run the frontend you just need to open the index.html file in your browser.
```bash
cd frontend
npm install
npm start
```
## How to use
To use the scrapper you just need to put the name of the amazon product in the input and click the search button. The result will be shown in the screen.
## API Documentation
The backend has a simple API that can be used to get the product information. The API has only one endpoint:
```http
GET /api/scrapper?keyword=product_name
```
| Params | Type | Description |
| :---------- | :--------- | :---------------------------------- |
| `keyword` | `string` | Search params |
The response will be a JSON with the following structure:
```json
[
{
"title": "product_title",
"price": "$9.99",
"rating": "4,5 out of 5 stars",
"reviews": "345",
"image": "product_image_url"
},
{
"title": "product_title_2",
"price": "$59.97",
"rating": "3,7 out of 5 stars",
"reviews": "227",
"image": "product_image_url"
}
]
```