Skip to content

StefanBratanov/sofia-supermarkets-api

Repository files navigation

sofia-supermarkets-api

build Quality Gate Status codecov

API за извличане на информация за продукти от супермаркети в София.

Swagger UI

Сайтове, използващи това API

Поддържани супермаркети

  • Billa

Получава информация за продуктите от https://ssbbilla.site/. Изображенията се извличат въз основа на първия резултат в търсенето на изображения в Google

  • Fantastico

Изтегля PDF брошурите от https://www.fantastico.bg/special-offers и анализира информацията за продуктите в тях. Изображенията се извличат въз основа на първия резултат в търсенето на изображения в Google.

  • Kaufland

Получава информация за продуктите от https://www.kaufland.bg/.

  • Lidl

Получава информация за продуктите от https://www.lidl.bg/.

  • T-Market

Получава информация за продуктите от https://tmarketonline.bg/.

  • METRO
  • Kam Market
  • CBA
  • ProMarket
  • Hit Max

Tech Stack

  • Kotlin
  • Gradle
  • Spring Boot

Code Style

Kotlin code conventions, based on ktfmt and google-java-format are used in this project. To reformat code, run:

./gradlew spotlessApply

Running Locally

Install JDK 17 or above from here.

  • Unix
./gradlew bootRun
  • Windows
gradlew.bat bootRun

The following environment variables need to be set prior to running:

  • DB_URL
  • DB_USERNAME
  • DB_PASSWORD
  • GOOGLE_API_KEY
  • CLOUDINARY_API_SECRET

Navigate to http://localhost:8080/swagger-ui.html to check the API documentation and test the endpoints.

API Documentation