Pixelis

PHP app for buying single pixels on a shared 1000×1000 canvas. Each pixel can be reserved, purchased and associated with a link and a short message.

Table of contents

• Quick links
• Prerequisites
• Quickstart (Docker)
• Local (OSPanel / native PHP)
• Running tests
• Security notes
• Developer tips
• Recommended next steps

Quick links

• API spec: openapi.yaml
• API endpoint: api/pixel.php

Prerequisites

• PHP 8 (recommended) or PHP 7.4+
• MySQL
• Docker & Docker Compose (recommended for local development)

Quickstart (Docker)

1. Clone the repository and enter it:

git clone <repo-url>
cd <repo>

2. Start services:

docker-compose up -d --build

3. Initialize the database (creates schema and optional seed user):

docker-compose exec php php src/setup_db.php --seed=dev:dev

4. Open http://localhost:8080 in your browser.

Local (OSPanel / native PHP)

• Place the repo under your webroot (for example d:\OSPanel\domains\localhost).
• Create a database main and update DB credentials via environment variables or a local .env file.
• Run the DB setup script:

php src/setup_db.php
# optional: php src/setup_db.php --seed=testuser:testpass

Running tests

• Install PHP dependencies:

composer install

• Run unit tests locally:

vendor/bin/phpunit

• Integration tests exercise the HTTP endpoints and are intended to run in Docker (CI runs them automatically).

Security notes

• Do not commit .env or credentials. Use .env.example as a template.
• Most DB queries use prepared statements; review any remaining interpolation and convert to prepared queries.
• Sanitize output with htmlspecialchars() (or use a templating engine) to prevent XSS.

Developer tips

• Use make test to run the full suite (if your environment has the required tools).
• Use docker-compose exec php bash to run commands inside the PHP container for debugging.

License

MIT — see LICENSE