Menorca Properties Api

Lightweight FastAPI service for scraping and exposing public property listings in Menorca.

---

Getting Started

This project includes a Dockerfile and a docker-compose.yml to run the application in a container.

• Build and start in the background

  docker-compose up -d --build

• Stop and remove containers

  docker compose down

Notes: The container exposes port 8080 which is forwarded to the host by the examples above. db.json and logs/ are mounted into the container so data and logs persist on the host.

Contributing

Contributions are welcome! To set up your development environment:

1. Clone the repository and enter the folder:

   git clone https://github.com/Bug-Not-Detected/menorca-properties-api.git
   cd menorca-properties-api

2. Create a virtual environment and install Python dependencies:

   python3 -m venv .venv
   source .venv/bin/activate
   pip install -r requirements.txt

3. Run the app locally:

   python run.py

License

See the LICENSE.md file for details.