marekprochazka / WatchDog

Django-Vue based application helping with repeating online purchases

---

‼ The project was stopped for lack of time and interest. ‼

It might be continued in Q1 of 2025

---

WatchDog

How to run the project locally (Windows):

• Install docker desktop
• Clone this repository (via cli or tools such as github desktop or gitkraken)
• Open project in your favorite IDE
• In root folder create .env file from .env.example
• run scripts/init_git.bash (skip if ends with error)
• run docker compose build
• run docker compose up
  • the app is served at port 8000
• for intellisense inside IDE you might need to install node dependencies locally which you can do by cd into services/frontend and running npm i

Updating dependencies

• run docker compose run --rm --user root django bash
• for python run poetry add ...
• for frontend go to services/frontend and run npm i ...

Formatting

• ./scripts/format or ./scripts/format.bat

Linting

• ./scripts/lint or ./scripts/lint.bat

BE tests

• docker compose --file docker-compose.test.yml up

Project description

Webscraper controlling prices of (mostly) supplements on various e-shops. The goal is to provide users with the best price for the product they are looking for. The app will also provide price history for each product and more.

Technologies used

• Template: django-vue-base
• Scraper: TBD
• Backend: Django
• Frontend: Vue.js
• Database: PostgreSQL
• Database hosting: Supabase
• Hosting: TBD
• Docker
• Poetry
• Vite
• Backend testing: pytest
• Frontend testing: TBD
• CI/CD: Github Actions
• API documentation: drf-spectacular
• Code formatting: black