main-doc.py is a heavily documented, entire yap-sesh dedicated version of main.py that tries to explain the code line-by-line. It assumes you have a little knowledge of the underlying syntax of the language, and outside of the ServerThread class, is more focused on HTTP servers and networking than the program specifics.

Running the Program

Ideally, you can run the program on Linux or Windows, and streamline the dependency process with uv.

Note that the servers bind to the default, well known ports for HTTP (80) and HTTPS (443). (443). This can be problematic as you sometimes need permissions in order to bind to these ports. When I do the demonstration, I temporarily disable the Linux kernel's restriction to only allow root user to bind to ports below 1024 with sudo sysctl net.ipv4.ip_unprivileged_port_start=0. This way, the restrictive behavior is reverted on restart.

Bypassing Port restriction

You can edit the constants in main.py to set the HTTP_PORT and HTTPS_PORT to something like 8080 and 4443 respectively.

If you have Podman/Docker, you can change the contents of docker-compose.yml to be like this instead:

      # Example for unprivileged:
      # - 127.0.0.1:8080:80
      # - 127.0.0.1:4443:443

Then when you visit it in the web browser, you have to add the port number, Ex: "http://127.0.0.1:8080" and "https://127.0.0.1:4443"

Native Python

This assumes you have Python (and Git) installed. Although there's a likelihood you don't even need Python if you use uv

If you don't have uv installed, first install it with:

Windows:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Linux/macOS:

curl -LsSf https://astral.sh/uv/install.sh | sh

Then you can clone the Git repo using

git clone {repo_url_here} && cd sniph-bank

Tip

Alternatively, if you don't have Git installed, you can download the code as a ZIP or tar.gz from the "CODE" button at the top of this repository. Unzip it and open the terminal in the folder containing all the code.

From there you can run the program using uv run main.py

uv will download the packages within a virtual environment and run the program there too.

Podman/Docker

Podman and Docker are both containerization platforms, where Docker is the easier to get installed and more well known, and Podman is the most secure and performant option, while also being compatible with the Docker cli and open-source. These can be used if you want to temporarily run the script within an isolated environment and not on your base system, and will allow you to change the IP address and port the script is listening on by editing the docker-compose.yml file rather than the main.py file.

However, I do not offer a simple run-and-done image for this app, so you have to clone the source code either way, and I additionally mount this directory to the container when you run it, so all the files are still stored on your system. To top things off, if you don't have podman-compose installed, you can install it with uv tool install podman-compose, so you'd want to have uv installed anyway. I might change this before I publish.

Assuming you have Podman and the podman-compose script installed on your system:

git clone https://git.foreverpyrite.com/ForeverPyrite/sniph-bank && cd sniph-bank
podman compose up -d

If you have Docker, you can just run

git clone https://git.foreverpyrite.com/ForeverPyrite/sniph-bank && cd sniph-bank
docker compose up -d

Why is the repo so large?

I still have the tailwindcss binary in the website/css/ directory. I could've got rid of it or put it in .gitignore or ignored it locally or something but nah. There is a very low chance that someone wants to tinker, and in that case (assuming you are in the root of the repo), you can rebuild the CSS with

./tw-css/tailwindcss -i tw-css/input.css -o website/css/style.css -w

But you have to be on 64-bit AMD Linux/WSL. Otherwise you gotta download your own.

Contact me.

ForeverPyrite. I use Discord btw.