From 961b487b84348827bfd9e1be62463988b0b788b8 Mon Sep 17 00:00:00 2001 From: Alex Holland <64433812+alexwholland@users.noreply.github.com> Date: Fri, 7 Apr 2023 20:43:15 -0700 Subject: [PATCH 1/3] Added Basic README description --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 682c381..01c03e9 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ -# Marketscrape \ No newline at end of file +# 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 that will pull a pre-built image from DockerHub and will run your website. + +```bash +$ docker compose up +``` + +Note that when you run it for the first time, it will download a docker image of size 300MB or so. + +- Finally, when your done running the project run the following command to shut down the containers. + +```bash +$ docker compose down +``` From ccad5df38ca4d187d9b626d59efce55d62c9c8b2 Mon Sep 17 00:00:00 2001 From: Alex Holland <64433812+alexwholland@users.noreply.github.com> Date: Fri, 7 Apr 2023 20:53:08 -0700 Subject: [PATCH 2/3] Updated incorrect instructions --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 01c03e9..17bb530 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ $ 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 that will pull a pre-built image from DockerHub and will run your website. +- Next, run the following command to start the container. ```bash $ docker compose up From b45262491fdbd275cd2dc2ecafbb168f200656e1 Mon Sep 17 00:00:00 2001 From: Alex Holland <64433812+alexwholland@users.noreply.github.com> Date: Fri, 7 Apr 2023 20:56:54 -0700 Subject: [PATCH 3/3] Updated image size --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 17bb530..f4fb94b 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ $ https://github.com/Marketscrape/marketscrape.git $ docker compose up ``` -Note that when you run it for the first time, it will download a docker image of size 300MB or so. +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.