plack.app

(β˜… 88)

No description available.

  • .editorconfig
  • .env.example
  • .gitattributes
  • .gitignore
  • .mcp.json
  • .oxlintrc.json
  • .prettierignore
  • AGENTS.md
  • artisan
  • boost.json
  • bun.lock
  • CLAUDE.md
  • components.json
  • composer.json
  • composer.lock
  • GEMINI.md
  • opencode.json
  • package.json
  • phpstan.neon
  • phpunit.xml
  • pint.json
  • plan.md
  • README.md
  • rector.php
  • tsconfig.json
  • vite.config.ts

# Installation Guide

1. Get the code
git clone https://github.com/nunomaduro/plack.app

Downloads the entire project code from GitHub to your computer.

cd plack.app

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) 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 setup

Type this command into your terminal and run it.

composer dev

Type this command into your terminal and run it.

composer dev # run the app (server + queue + logs + vite)

Type this command into your terminal and run it.

composer test # the full check: linting, types, static analysis, and tests

Type this command into your terminal and run it.

composer lint # auto-fix code style (Rector + Pint for PHP, vp for JS/TS)

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.

// repository documentation