nkaajtooj / webman-starter

dev-master 2026-09-30 08:18 UTC

Requires

• php: >=8.3
• ext-curl: *
• ext-dom: *
• ext-json: *
• ext-pdo: *
• ext-redis: *
• ext-zip: *
• illuminate/events: ^12.69
• illuminate/pagination: ^12.69
• leekung/webman-migrations: dev-main
• monolog/monolog: ^2.0
• symfony/var-dumper: ^7.4
• vlucas/phpdotenv: ^5.7
• webman-tech/auth: ^5.1
• webman-tech/laravel-cache: ^12.0
• webman-tech/laravel-filesystem: ^12.0
• webman-tech/laravel-http: ^12.0
• webman-tech/laravel-validation: ^12.0
• webman/blade: ^1.5
• webman/console: ^2.2
• webman/database: ^2.1
• webman/redis: ^2.1
• webman/think-orm: ^2.1
• webman/validation: ^2.2
• workerman/webman-framework: ^2.1

Suggests

• ext-event: For better performance.

MIT

• High Performance
• http service

Published on Packagist.org on 2026-09-30 08:19 UTC

README

A PHP 8.3+ starter project built on Webman. It includes Webman Console, database integrations (Eloquent and Think ORM), Redis, validation, Blade, migrations, and Laravel-style cache, filesystem, HTTP client, and authentication packages.

Requirements

• PHP 8.3 or newer and Composer
• PHP extensions: curl, dom, json, pdo, zip, and redis (see composer.json)
• A database or Redis server only if your application uses those integrations

Get started

From a checkout of this repository:

composer install
cp .env.example .env
php start.php start

Open http://127.0.0.1:8787. The starter's home page is the default Webman welcome page. The HTTP listener is configured in config/process.php.

For a background process, use php start.php start -d; stop it with php start.php stop. Run php webman list to see the available console commands.

Configuration

Copy .env.example to .env and set values relevant to your application. The environment file is ignored by Git. APP_URL and the AWS_* values are used by the filesystem configuration in config/plugin/webman-tech/laravel-filesystem/filesystems.php; CACHE_STORE selects the cache store and defaults to file.

The database and Redis connections currently have their own settings in config/database.php, config/think-orm.php, and config/redis.php. Set those files for your services: the DB_* and REDIS_* entries in .env.example are not wired into these connection configs. The default database examples point to local MySQL, while Redis defaults to 127.0.0.1:6379.

Change the timezone in config/app.php and the locale in config/translation.php. The default view handler is Raw in config/view.php; configure Blade there if you want to render Blade templates.

Setup wizard

composer setup-webman runs the interactive setup wizard. It lets you choose a locale, timezone, and optional Console, database, Redis, validation, and template packages. It can update composer.json by installing selected packages and removing installed components you did not select. It asks for confirmation before removing primary components. Review your selections before running it in an existing project. The wizard is skipped in non-interactive Composer sessions.

Project layout

Path	Purpose
app/controller/	HTTP controllers; IndexController contains the example actions
app/model/	Example model
app/view/	Example view
config/	Webman and plugin configuration
database/	Migration and seeder paths used by the migrations plugin
public/	Public web assets
resource/translations/	Translation files
runtime/	Runtime data and logs

For migration commands, run php webman list and look for migrate:* and seed:*. Configure the database connection before using them.

Documentation and license

See the Webman documentation for framework usage. This project is licensed under the MIT License.