PS5Tracker

This is the PS5 Tracker server. The server is designed to handle retailer availabilities and auto purchasing a PS5.

Getting Started

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

Setting Up WSL

If you are a Windows user, I highly suggest setting up WSL and using Ubuntu as your OS. This is because some libraries that we use for this repo do not work in a Windows environment.

To set up WSL in Windows 10/11, follow these instructions to get WSL set up on your Windows machine: Windows Subsystem for Linux Installation Guide for Windows 10

Cloning the Repository

If you haven't already, you will need to clone the kwilson21/PS5Tracker GitHub repository to your local machine.

First generate an SSH key

ssh-keygen -t rsa -b 4096

When generating the SSH key, it is suggested that you keep a default file name and not set a passphrase as you will need to enter it everytime you use a git command.

Once you generate an SSH key, copy the SSH key to your clipboard

cat ~/.ssh/id_rsa.pub

Once you have the key in your clipboard, head over to GitHub, select Settings -> SSH and GPG keys and add a new SSH key. For more details, see Generating a new SSH key and adding it to GitHub.

Once you have linked the SSH key to your GitHub account, clone the GitHub repo

cd
mkdir repos
cd repos
git clone git@github.com:kwilson21/PS5Tracker.git

Setting Up Your Environment

Getting started with PS5Tracker, you will need to install Python version 3.9 or above.

On Ubuntu, it is recommended that you use pyenv to manage your python versions

To install pyenv

curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash

Once you have pyenv installed, you will need to add pyenv to your path

echo -e 'if shopt -q login_shell; then' \
      '\n  export PYENV_ROOT="$HOME/.pyenv"' \
      '\n  export PATH="$PYENV_ROOT/bin:$PATH"' \
      '\n eval "$(pyenv init --path)"' \
      '\nfi' >> ~/.bashrc
echo -e 'if [ -z "$BASH_VERSION" ]; then'\
      '\n  export PYENV_ROOT="$HOME/.pyenv"'\
      '\n  export PATH="$PYENV_ROOT/bin:$PATH"'\
      '\n  eval "$(pyenv init --path)"'\
      '\nfi' >>~/.profile

Finally, source your profile to save the changes

source ~/.profile

Install python 3.9.6 (to see other python versions you can install, use pyenv install --list)

sudo apt update -y
sudo apt install -y build-essential gdb lcov libbz2-dev libffi-dev libgdbm-dev liblzma-dev libncurses5-dev libreadline-dev libsqlite3-dev libssl-dev lzma lzma-dev tk-dev uuid-dev zlib1g-dev
pyenv install 3.9.6

Next, you will need to set your repo directory to use python3.9 when in the directory and install pipenv

cd ~/repos/PS5Tracker
pyenv local 3.9.6
pip install pipenv

Once you have pipenv installed, use pipenv to install the required packages

cd ~/repos/PS5Tracker
pipenv install --dev

Configuring Environment Variables

To configure your environment variables for this app, create a file called .env in the project root directory and set the following variables accordingly

DATABASE_HOST=127.0.0.1
DATABASE_PORT=3306
DATABASE_NAME=test
DATABASE_USER=root
DATABASE_PASSWORD=1234
REDIS_HOST=localhost
REDIS_PORT=6379
APP_ENV=development
URL=https://example.com/
TWILIO_ACCOUNT_SID=
TWILIO_AUTH_TOKEN=
TEST_EMAIL=test@test.com
TEST_PHONE_NUMBER=+15551234567
WEB_DRIVER=chrome
SECRET_KEY=

You can generate a secret key for your local environment using the following command

python -c "import os; print(os.urandom(24).hex())"

Pre commit

We have a configuration for pre-commit, to add the hook run the following command

cd ~/repos/PS5Tracker
pipenv shell
pre-commit install

Installing MySQL

To install MySQL on Ubuntu

sudo apt install -y mysql-server

After installation, start the MySQL server

sudo service mysql start

Lastly, before running the app, you must create the database that you will use and set a password for your root account

sudo mysql -u root
mysql> CREATE DATABASE test;
mysql> ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY '1234';

Installing Redis

You will need to install Redis to test RQ jobs and test retailer availability code

sudo apt install redis-server

After installation, start the redis server

sudo service redis-server start

Install Google Chrome and ChromeDriver

PS5Tracker's retailer services relies on Selenium to scrape PS5 availabilities from websites. To do this, it uses Chrome in headless mode. Because of this, we must ensure our environment has Google Chrome and Chromedriver installed so that Selenium can find them.

I created a script to make this process easy

cd ~/repos/PS5Tracker
sudo bash setup-chrome.sh

Running the App

Once your development environment is set up, you are now ready to run the app and start developing.

Start the webserver

cd ~/repos/PS5Tracker
pipenv shell
honcho start

Running a task

Once you have the app up and running, you can test out RQ by running a task

from app.rq.jobs import update_retailer_availabilities
from app.constants import RQ_REDIS_CONN, TARGET_RETAILER
from rq import Queue

q = Queue(connection=RQ_REDIS_CONN)
q.enqueue(update_retailer_availabilities, args=[TARGET_RETAILER])

This task will get PS5 availabilities from the target website, and store the results in redis.

After updating retailer availabilities, you can query the API to get retailer availabilities by going to http://localhost:5000/docs

Deploying

The app is already pre-configured to be deployed using Heroku. You can check out their documentation for setting up a Python app here