README

An early-stage Laravel framework project by davingm. It combines a Laravel application with file-based Blade pages, framework generators, and a small server-rendered frontend toolchain.

Warning

This project is still in its early stages and continues to evolve. The API, conventions, supporting tools, and documentation are subject to change with each release. Do not assume backward compatibility or production readiness; evaluate the project in an isolated environment, pin the versions you have tested, and ensure it meets your requirements before relying on it. Be sure to read the framework's License before getting started.

Try the published starter

Create a new application from the published Composer project:

composer create-project davingm/laravel my-app
cd my-app

The starter materializes the application from the package and installs the Composer runtime plugin that generates the ignored .laravel/ directory. Follow the installation guide for requirements and troubleshooting.

Develop this repository

This is a monorepo: the framework runtime and its Composer plugin are maintained separately from the Laravel application used to exercise them.

Path	Purpose
`packages/laravel/src/`	Composer plugin that installs the framework runtime
`packages/laravel/.laravel/`	Editable framework runtime source
`playground/`	Laravel application used for development and tests
`playground/.laravel/`	Generated runtime copy; do not edit directly
`docs/`	User guides, developer documentation, and clearly marked design notes

Isolated setup with Dev Containers

Install Docker Desktop or another Docker-compatible engine, Visual Studio Code, and its Dev Containers extension.
Clone this repository and open its root folder in VS Code.
Run Dev Containers: Reopen in Container from the Command Palette. The container installs dependencies and prepares playground/ on first creation.
In the container terminal:
```
cd playground
composer run dev
```

The development server uses port 8000. The Dev Container configuration is also the reproducible PHP/Composer/Node environment used for local development.

Setup on your own machine

Requirements: PHP ^8.3, Composer 2, Node.js and npm. From the repository root:

cd playground
composer run setup
composer run dev

Run composer run setup once for a fresh checkout; it installs dependencies, prepares local environment/database files, generates an application key, runs migrations, and builds frontend assets. Do not rerun setup over an application whose local key or database you need to preserve.

Tests and frontend build

Run these from playground/:

node .laravel/cli.js test --compact
npm run build

The GitHub Actions workflow also runs the test suite and frontend build, then checks the application through Apache. See contribution guidelines for focused checks and pull request expectations.

Documentation and community

The docs/discussion/ folder contains historical or exploratory material, not authoritative implementation instructions. Verify proposals against the current source.

License

The current project source is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0-only). Third-party dependencies and materials retain their respective licenses. Earlier published releases may carry different, historical license metadata; changing the source branch does not change the license attached to an existing release.

Packagist derives metadata from each tag and branch's own composer.json; changing main does not rewrite metadata for existing releases or branches. After a tag or branch is changed or removed, Packagist and Composer may still show cached metadata. Refresh the package on Packagist and run composer clear-cache locally before diagnosing a mismatch. Check the exact version or branch you install if its registry metadata matters to you.

davingm / laravel

Package info

Security

Fund package maintenance!

Statistics