fix: update readme and development env

README.md

@@ -3,8 +3,7 @@
 
 # ➤ 🏡 Hoomes: Your Gateway to Italian Real Estate 🏡
 
-
-Welcome to **Hoomes**,, a tool for scraping and searching homes for sale in Italy. Hoomes helps users find properties by gathering data from leading real estate platforms like [Idealista](https://www.idealista.it/) and [Caaasa.it](https://www.caasa.it/). What sets Hoomes apart is its ability to search within property comments, giving you deeper insights into listings. Whether you're browsing or searching for something specific, Hoomes provides the information you need to make informed decisions.
+Welcome to **Hoomes**, a tool for scraping and searching homes for sale in Italy. Hoomes helps users find properties by gathering data from leading real estate platforms like [Idealista](https://www.idealista.it/) and [Caaasa.it](https://www.caasa.it/). What sets Hoomes apart is its ability to search within property comments, giving you deeper insights into listings. Whether you're browsing or searching for something specific, Hoomes provides the information you need to make informed decisions.
 
 ![demo](https://github.com/pinkynrg/Hoomes/blob/main/demo.gif)
 
@@ -22,23 +21,41 @@ When you make a request, Hoomes scrapes the data on-demand, so it may take a bit
 
 ## ➤ 🚀 Getting Started
 
+### Requirments
+
+Make sure to install all the necessary dependencies:
+
+- **Docker**: Required for containerization and easy environment setup.
+- **Poetry**: A tool for managing Python dependencies and virtual environments.
+
+
 ### Clone the Repository
 
 ```bash
 git clone https://github.com/yourusername/hoomes.git
 cd hoomes
 ```
 
-### Bootstrap Your Development Environment
+To install npm packages:
+
+```bash
+npm install
+```
+
+To install pip packages:
+
+```bash
+cd server && poetry install && cd..
+```
+
+### Start the Project
 
-To kickstart your development environment, use the following command:
+To start the project, use the following command:
 
 ```bash
 npm start
 ```
 
-This command will start all necessary services concurrently, ensuring that your development environment is fully operational with a single command. The `concurrently` package is used under the hood to run multiple npm scripts simultaneously, streamlining your workflow and minimizing setup time.
-
 
 [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#-future-enhancements)
 

blueprint.md

@@ -1,7 +1,6 @@
 # 🏡 Hoomes: Your Gateway to Italian Real Estate 🏡
 
-
-Welcome to **Hoomes**,, a tool for scraping and searching homes for sale in Italy. Hoomes helps users find properties by gathering data from leading real estate platforms like [Idealista](https://www.idealista.it/) and [Caaasa.it](https://www.caasa.it/). What sets Hoomes apart is its ability to search within property comments, giving you deeper insights into listings. Whether you're browsing or searching for something specific, Hoomes provides the information you need to make informed decisions.
+Welcome to **Hoomes**, a tool for scraping and searching homes for sale in Italy. Hoomes helps users find properties by gathering data from leading real estate platforms like [Idealista](https://www.idealista.it/) and [Caaasa.it](https://www.caasa.it/). What sets Hoomes apart is its ability to search within property comments, giving you deeper insights into listings. Whether you're browsing or searching for something specific, Hoomes provides the information you need to make informed decisions.
 
 ![demo](https://github.com/pinkynrg/Hoomes/blob/main/demo.gif)
 
@@ -13,23 +12,41 @@ When you make a request, Hoomes scrapes the data on-demand, so it may take a bit
 
 ## 🚀 Getting Started
 
+### Requirments
+
+Make sure to install all the necessary dependencies:
+
+- **Docker**: Required for containerization and easy environment setup.
+- **Poetry**: A tool for managing Python dependencies and virtual environments.
+
+
 ### Clone the Repository
 
 ```bash
 git clone https://github.com/yourusername/hoomes.git
 cd hoomes
 ```
 
-### Bootstrap Your Development Environment
+To install npm packages:
+
+```bash
+npm install
+```
+
+To install pip packages:
+
+```bash
+cd server && poetry install && cd..
+```
+
+### Start the Project
 
-To kickstart your development environment, use the following command:
+To start the project, use the following command:
 
 ```bash
 npm start
 ```
 
-This command will start all necessary services concurrently, ensuring that your development environment is fully operational with a single command. The `concurrently` package is used under the hood to run multiple npm scripts simultaneously, streamlining your workflow and minimizing setup time.
-
 ## 🛠️ Future Enhancements
 
 We aim to integrate additional real estate platforms, making it easier than ever to find your dream home in Italy. Stay tuned for updates and new features!

docker-compose.development.yml

@@ -1,75 +1,7 @@
-version: '3.8'
 services:
-
-  vpn:
-    container_name: vpn
-    hostname: vpn
-    image: ghcr.io/bubuntux/nordlynx
-    ports:
-      - "5001:5001"
-    cap_add:
-      - NET_ADMIN
-      - SYS_MODULE
-    environment:
-      - PRIVATE_KEY=$NORD_VPN_PRIVATE_KEY
-      - QUERY=filters\[country_id\]=106 # ITALY
-      - NET_LOCAL=192.168.0.0/16
-    sysctls:
-      - net.ipv4.conf.all.src_valid_mark=1
-      - net.ipv4.conf.all.rp_filter=2
-      - net.ipv6.conf.all.disable_ipv6=1
-
-  backend:
-    container_name: hoomes_backend
-    build:
-      context: .
-      dockerfile: ./Dockerfile.backend
-    environment:
-      REDIS_HOST: localhost
-      REDIS_PORT: 6379
-    volumes:
-      - ./server:/app
-    network_mode: service:vpn
-    command: poetry run python server.py
-    restart: always
-    depends_on:
-      - redis
-      - vpn
-
-  frontend:
-    container_name: hoomes_frontend
-    ports:
-      - "80:80"
-    build:
-      context: .
-      dockerfile: Dockerfile.frontend
-    extra_hosts:
-      - "host.docker.internal:host-gateway"
-    depends_on:
-      - backend
-      - vpn
-
-  worker:
-    container_name: hoomes_workers
-    build:
-      context: .
-      dockerfile: ./Dockerfile.backend
-    environment:
-      REDIS_HOST: localhost
-      REDIS_PORT: 6379
-    volumes:
-      - ./server:/app
-    command: poetry run python worker.py
-    network_mode: service:vpn
-    restart: always
-    depends_on:
-      - redis
-      - vpn
-
   redis:
     container_name: redis
     image: redis:7.2.2
     restart: always
-    network_mode: service:vpn
-    depends_on:
-      - vpn
+    ports:
+      - "6379:6379"

package.json

@@ -54,7 +54,7 @@
     "xcase": "^2.0.1"
   },
   "scripts": {
-    "start": "concurrently --names 'frontend, backend, workers' -c 'bgBlue.bold,bgMagenta.bold,bgGreen.bold' \"npm run start-frontend\" \"npm run start-backend\"  \"npm run start-workers\"",
+    "start": "concurrently --names 'frontend, backend, workers,   redis' -c 'bgBlue.bold,bgMagenta.bold,bgGreen.bold,bgYellow.bold' \"npm run start-frontend\" \"npm run start-backend\"  \"npm run start-workers\"   \"docker compose -f docker-compose.development.yml up\"",
     "build": "react-scripts build",
     "test": "react-scripts test",
     "eject": "react-scripts eject",

server/pyproject.toml

@@ -4,6 +4,7 @@ version = "0.1.0"
 description = ""
 authors = ["Francesco Meli"]
 readme = "README.md"
+package-mode = false
 
 [tool.poetry.dependencies]
 python = "^3.10"