Installation

Clone the Repository

git clone https://github.com/Shaykhnazar/olx-price-monitor.git

Setup Environment Variables

In the root directory of the project, create a .env file and set the following environment variables:

cp .env.example .env

And set the following environment variables in the .env file:

DB_HOST=db
DB_NAME=olx_price_monitor
DB_USER=olx_user
DB_PASS=olx_secret

SMTP_HOST=sandbox.smtp.mailtrap.io
SMTP_PORT=2525
SMTP_USER=user
SMTP_PASS=password
[email protected]
SMTP_NAME="OLX Price Monitor"

[email protected]

Build and Restart the Containers

docker-compose up -d

---

Database

Access the MySQL Container

docker-compose exec db bash

Log into MySQL as Root

mysql -u root -p

Enter the password you set in MYSQL_ROOT_PASSWORD (e.g., "secret").

List databases:

SHOW DATABASES;

You should see olx_price_monitor in the list.

List tables:

SHOW TABLES;

List subscriptions:

SELECT * FROM subscriptions;

Example:

$ mysql -u root -p
Enter password: ********
mysql> USE olx_price_monitor;
Database changed
mysql> SHOW TABLES;
+---------------------+
| Tables_in_database  |
+---------------------+
| subscriptions       |
+---------------------+
1 row in set (0.00 sec)

mysql> exit;
Bye

---

Usage API via Postman

Postman Collection

The Postman collection is available at olx-price-monitor.postman_collection.json.

1. Import the collection into Postman.
2. Open the collection in Postman.
3. Subscribe to an ad using the "Subscribe" endpoint. /subscribe
4. Confirm your subscription using the "Confirm" endpoint. /confirm?token={token}

---

Running Tests

Run all tests

Execute the entire test suite:

vendor/bin/phpunit

Run a specific test file

To run tests from a specific file, provide the path:

vendor/bin/phpunit tests/SubscriptionTest.php

Run a specific test method

To run a specific test method (e.g., testCreateSubscription), use the --filter option:

vendor/bin/phpunit --filter testCreateSubscription tests/SubscriptionTest.php

Run with readable output

Use --testdox for a more human-readable output:

vendor/bin/phpunit --testdox

Run with code coverage

Result:

Price checking works via cron job

The price checking is done via cron job, so it should work as expected. Every 1 hour, the cron job will check the price of the ad and send an email notification if the price has changed.

How works web parser

Using voku/simple_html_dom package. We can get the price from the web page.

And we get the price of the ad via the parser like this. This is to display for testing purpose only.