p1-bargain

This project was made by a group of 1st semester computer science students at Aalborg University, as part of an exam project. It is accompanied by a report looking into bargain hunting in 2022.

Git

This repo contains sub-repositories for most dependencies, and as such, should be cloned using the recursive flag

git clone https://github.com/Bliztle/p1-bargain --recursive

The repo is set up such that no one but the owner has permissions to push directly to the main branch. Instead, everyone must push their changes to seperate branches, and then create a pull request for someone else to sign off on.

Setup

This project comes with setup for cmake, but does NOT include any build tools. Depending on your OS you may face various issues setting up / building the project, so we recommend using either github codespaces or a linux distro set up for development. Alternatively, this repo includes a few DLL's which may be needed for windows development, located in cmake-build-debug/src - the default build directory when using CLion.

Dependencies

• Included
  • libcurl v7.86.0
  • nxJson vCurrent
• Not included
  • openssl
  • libssl-dev

Openssl isn't included by default, due to being too OS specific. It should come pre-installed on windows, and can easily be installed on linux. MacOS users should look into installing homebrew.

Linux

General linux install options. Look up the relevant variant for your distro

sudo apt update && sudo apt upgrade -y

sudo apt install openssl -y

sudo apt install libssl-dev -y

sudo apt install cmake -y

git clone https://github.com/Bliztle/p1-bargain --recursive && cd p1-bargain

And for building the project:

cmake . -B build

make -C build

The executable will be placed in the /build/src folder. To run it, execute the following line:

./build/src/main

Known issues

• Segmentation fault when changing address or maximum distance, or when finding bargains

  In the tail end of the week, it is possible to have ran out of API calls to COOP. The authors are actively keeping an eye on this, and will try to update the keys before this happens. Should it happen anyway, either raise an issue on github or create an account at https://developer.cl.coop.dk/ and replace the COOP_TOKEN macro at the top of src/api/fetch.c. This key is non-private and is included to help developers during setup, but should be replaced at the earliest convenience.