Merge pull request #18 from Marketscrape/alexwholland-update_readme

Added Basic README description
This commit is contained in:
Bhavanvir Rai
2023-04-07 21:47:16 -07:00
committed by GitHub

View File

@@ -1 +1,24 @@
# Marketscrape
# Marketscrape
Marketscrape is a user-friendly web scraper for Facebook Marketplace that utilizes AI to help users assess the value of each listing, and by providing real-time analysis and advanced machine learning algorithms, it empowers users to make informed purchasing decisions and find the best deals on Facebook Marketplace.
## Installation
Clone the repository
```bash
$ https://github.com/Marketscrape/marketscrape.git
```
### Local setup using Docker
- First, install [docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/).
- Next, run the following command to start the container.
```bash
$ docker compose up
```
Note that when you run it for the first time, it will download a docker image of size 4.5GB or so.
- Finally, when your done running the project run the following command to shut down the containers.
```bash
$ docker compose down
```