Skip to content
/ DealHub Public

DealHub is a a web application that allow users to post deals on products and services.

License

Notifications You must be signed in to change notification settings

Qwizi/DealHub

Repository files navigation

DealHub

PyPI - Python Version Create Release Publish Backend Docker image

DealHub is a a web application that allow users to post deals on products and services.

Build with

  • Django
  • DaisyUI
  • HTMX
  • Postgres
  • Docker

Live Demo

DealHub

Installation

  • Linux

    Prerequisites

    • Docker
    • Curl
    curl -fsSL https://raw.githubusercontent.com/Qwizi/DealHub/master/scripts/install.sh | bash
  • Windows (Powershell)

    Prerequisites

    • Docker Desktop
    Invoke-Expression ((New-Object System.Net.WebClient).DownloadString("https://raw.githubusercontent.com/Qwizi/DealHub/master/scripts/install.ps1"))

Wiki

  • Loading stock data

    cd DealHub
    ./scripts/stock_data.sh
  • Creating Categories

    • Go to the admin panel http://localhost:8000/admin
    • Login with the credentials you provided during the installation
    • Go to the Categories section and create a new category

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Python 3.10 or higher
  • Poetry
  • Git
  • Docker

Installation

With pip

  1. Clone the repository: This will create a copy of this project on your local machine.

    git clone https://github.com/Qwizi/DealHub
  2. Install dependencies: Navigate into the cloned project's directory and install the necessary dependencies.

    cd DealHub
    python -m venv venv
  3. Activate the virtual environment: This step ensures that the hooks are installed and active.

    venv/Scripts/Activate
  4. Install dependencies

    pip install -r .\requirements.txt
  5. Copy .env.example to .env

    mv .env.example .env
  6. Start docker desktop app

  7. Run the application: This will start the application on your local machine.

    ./scripts/run.ps1

With poetry

  1. Install Poetry: Poetry is a tool for dependency management and packaging in Python. You can use pipx to install it globally, which is recommended.

    pipx install poetry
  2. Clone the repository: This will create a copy of this project on your local machine.

    git clone https://github.com/Qwizi/DealHub
  3. Install dependencies: Navigate into the cloned project's directory and install the necessary dependencies.

    cd DealHub
    poetry install
  4. Activate the virtual environment: This step ensures that the hooks are installed and active.

    poetry shell
  5. Run the application: This will start the application on your local machine.

    ./scripts/run.sh

ShowCase

image 1 image 2 image 3

Legal info

© Copyright by Adrian Ciołek (@Qwizi), Mateusz Cyran (@Kuis03), Kamil Duszyński (@VirdisPl), Dawid Dymek (@dawiddymek1108), Nikodem Decewicz (Szimurka).