NaviDiscounts

NaviDiscounts is a telegram bot that helps you find discounts on your favorite products on certain websites.

Technologies

• Kotlin
• Java Telegram
• PostgreSQL
• Jsoup
• Selenium

Supported Websites

• Mifarma
• InkaFarma

Commands

• /start - Get the list of commands.
• /add - Add a URL to the list of requests.
• /delete - Delete a URL from the list of requests.
• /list - Get the list of requests.
• /stop - Stop receiving product information and delete all added products.
• /exe - Execute the scheduler.

Endpoints

• /health - Check if the bot is running.

How to build

Production mode

Run the project in production mode with the following command:

java -jar build/libs/NaviDiscounts-{version}.jar \
 --spring.profiles.active=prod \
 --spring.datasource.url=jdbc:postgresql://{YOUR_DATABASE_HOST}:{YOUR_DATABASE_PORT}/{YOUR_DATABASE_NAME} \
 --spring.datasource.username={YOUR_DATABASE_USERNAME} \
 --spring.datasource.password={YOUR_DATABASE_PASSWORD} \
 --spring.bot.token=${TELEGRAM_BOT_TOKEN} \
 --spring.bot.scheduler.enabledExeCommand={false|true} \
 --spring.bot.scheduler.timeZone={TIME_ZONE:UTC} \
 --spring.bot.scheduler.executionTime={EXECUTION_TIME:00:00}

Development Mode

Run the project in development mode with the following command:

java -jar build/libs/NaviDiscounts-{version}.jar \
 --spring.bot.token=${TELEGRAM_BOT_TOKEN} \
 --spring.bot.scheduler.timeZone={TIME_ZONE:UTC} \
 --spring.bot.scheduler.executionTime={EXECUTION_TIME:00:00}

Running with Docker

You can run NaviDiscounts and its required PostgreSQL database using Docker Compose. This project provides a Dockerfile (using Gradle 8.10.2 and JDK 17) and a docker-compose.yml for easy setup.

Requirements

• Docker and Docker Compose installed

Environment Variables

The following environment variables are required for the bot to function. You can set them in a .env file or directly in the docker-compose.yml under the environment section:

• TELEGRAM_BOT_TOKEN - Your Telegram bot token
• DB_HOST - Database host (default: postgres)
• DB_PORT - Database port (default: 5432)
• DB_NAME - Database name (default: navi_discounts)
• DATASOURCE_USERNAME - Database username (default: postgres)
• DATASOURCE_PASSWORD - Database password (default: postgres)

The PostgreSQL service uses the following variables (with defaults):

• POSTGRES_DB=navi_discounts
• POSTGRES_USER=postgres
• POSTGRES_PASSWORD=postgres

Build and Run

To build and start the services, run:

docker compose up --build

This will build the Kotlin application and start both the bot and a PostgreSQL database. The application will wait for the database to be ready before starting.

• Data for PostgreSQL is persisted in a Docker volume (pgdata).

how to use

1. Add the bot to your telegram account
2. Send the command /start to the bot
3. Send the command /add to the bot
4. Send the URL of the product you want to track
5. Wait for the bot to send you a message with the discount information
6. If you want a command to execute the scheduler, you can enable it with the enabledExeCommand parameter
7. Enjoy!

Contributions

If you want to contribute to the project, you can create a pull request with the changes you want to make. If you have any questions or issue, you can create an issue.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.