Chinese Checkers CLI

A simple two-player Chinese Checkers game playable in the terminal, written in Go.

Features ✨

• Standard Go project structure (cmd/, internal/).
• Web application (web/).
• Makefile for automating common development tasks (build, test, lint, run).
• Dockerfile for a consistent Go development environment with necessary tools (including staticcheck).
• web/Dockerfile for easy deployment and local tests.
• Linting configured with staticcheck.

🛠️ Requirements

Before you begin, ensure you have the following installed:

• Docker: To build and run the development container. Install Docker
• Make: To use the Makefile automation. (Usually pre-installed on Linux/macOS, may need installation on Windows).

(Note: PHP, Go and staticcheck do NOT need to be installed locally.)

🚀 Getting Started

Clone the repository, then:

1. Install the development Docker Image: This creates the container images with the Go environment and tools, and the PHP environment. Run this once initially, or when the Dockerfile or web/Dockerfile changes.

   make install

2. Run the CLI: This runs the CLI game inside the container.

   	# Show help.
   	APP_ARGS="--help" make run
   	# Run with arguments.
   	APP_ARGS="--state-file tests/states/ongoing-game.json --move c1,d1" make run

3. Test: Runs all PHP and Go tests inside containers.

   make test

4. Using Make Commands: With the container running, use standard make commands directly from your terminal. They automatically execute inside the Docker container:

    —— Chinese Checkers ♟️ ——————————————————————————————————————————————————————
   help                           Outputs this help screen
   install                        Builds the Docker images for cli and web apps.
    —— CLI app ⌨️ ———————————————————————————————————————————————————————————————
   build                          Build the Go binary (inside Docker).
   start-cli                      Run the CLI application.
   deps                           Tidy `go.mod` and `go.sum` files (inside Docker).
   lint                           Run `staticcheck` linter (inside Docker).
   vet                            Run `go vet` (inside Docker).
   check                          Run `staticcheck` and `go vet` (inside Docker).
   clean                          Remove the built binary (inside Docker).
    —— Web app 🌐 ———————————————————————————————————————————————————————————————
   up                             Start web app in detached mode.
   start-web-app                  Build and start the web application
   down                           Stop web app
   logs                           Show live logs
   sh                             Connect to the FrankenPHP container
   bash                           Connect to the FrankenPHP container via bash so up and down arrows go to previous commands
   test                           Run tests with phpunit, pass the parameter "c=" to add options to phpunit, example: make test c="--group e2e --stop-on-failure"
    —— Composer 🧙 ——————————————————————————————————————————————————————————————
   composer                       Run composer, pass the parameter "c=" to run a given command, example: make composer c='req symfony/orm-pack'
   vendor                         Install vendors according to the current composer.lock file
   composer-install               Install web app dependencies according to the current composer.lock file
   composer-install-test          Install dependencies for testing the web app
    —— Symfony 🎵 ———————————————————————————————————————————————————————————————
   sf                             List all Symfony commands or pass the parameter "c=" to run a given command, example: make sf c=about
   cc                             Clear the cache

   (See Makefile Targets below or run make help for all commands)

🧱 Project Structure (main folders)

cmd/chinese-checkers/ # Main entry point
internal/game/        # Core game logic
bin/                  # Binary file
web/                  # Web application (Symfony)