Skip to content

Kajta134/cenownik

Repository files navigation

Cenownik Bot

A RESTful API built with NestJS that allows users to receive notifications when a product price drops below a defined threshold.


Table of Contents


Features

  • Price scraping from supported shops
    Automatically checks whether a product price has dropped below a specified threshold.

  • Email and Discord notifications
    Notifies users via email and Discord when a price drop occurs.

  • Price history tracking
    Access historical price data for tracked products.

  • User management
    Registration, authentication, and role-based access control.

  • Configurable scraping frequency
    Ability to manage how often prices are checked.

  • Swagger integration
    API documentation available via Swagger UI.


Supported Shops


Technologies


Installation

  1. Clone the repository:
git clone <repository-url>
cd <repository-folder>
  1. Install dependencies:
npm install
  1. Configure the .env file.
DATABASE_URL="postgresql://username:password@localhost:5432/cenownik"
JWT_SECRET=your_jwt_secret
MAIL_USER=your_email_address
MAIL_PASS=your_email_password
DISCORD_TOKEN=your_discord_bot_token
  1. Setup database:
npx prisma generate

npx prisma migrate dev

npx prisma db seed
  1. Start the development server:
npm run start:dev
  1. Access API documentation at: http://localhost:3000/api (Swagger UI)

About

Cenownik project for KN-Solvro

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors