Finite

(โ˜… 1,351)

A Simple PHP Finite State Machine

  • .dockerignore
  • .editorconfig
  • .gitignore
  • .gitmodules
  • .php-cs-fixer.dist.php
  • composer.json
  • dagger.json
  • Dockerfile
  • infection.json5
  • LICENSE
  • Makefile
  • phpunit.xml.dist
  • psalm.xml
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/yohang/Finite

Downloads the entire project code from GitHub to your computer.

cd Finite

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t finite .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 finite

Runs the built image as an actual container.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. PHP (Composer)

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • PHP A PHP runtime is required.
  • Composer The package manager used to install PHP libraries.
$ composer req yohang/finite

Type this command into your terminal and run it.

โœ… Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

4. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation