--- title: Getting Started description: Quick start guide for creating a new Core PHP Framework application updated: 2026-01-29 --- # Getting Started This guide walks you through creating your first application with Core PHP Framework using the core-template. ## Prerequisites - PHP 8.2 or higher - Composer 2.x - Node.js 18+ and npm - SQLite (default) or MySQL/PostgreSQL ## Installation ### 1. Clone the Template ```bash git clone https://github.com/host-uk/core-template.git my-project cd my-project ``` Or use Composer create-project (once published): ```bash composer create-project host-uk/core-template my-project ``` ### 2. Install Dependencies ```bash # PHP dependencies composer install # JavaScript dependencies npm install ``` ### 3. Configure Environment ```bash # Copy environment file cp .env.example .env # Generate application key php artisan key:generate # Create SQLite database touch database/database.sqlite # Run migrations php artisan migrate ``` ### 4. Start Development Server ```bash # In one terminal - PHP server php artisan serve # In another terminal - Vite dev server npm run dev ``` Visit http://localhost:8000 to see your application. ## Creating Your First Module The Core PHP Framework uses a modular architecture. Features are organised as self-contained modules. ### Using the Artisan Command ```bash # Create a full-featured module php artisan make:mod Blog --all # Or select specific features php artisan make:mod Blog --web --api ``` ### Manual Creation 1. Create the module directory: ```bash mkdir -p app/Mod/Blog/{Models,Routes,Views,Livewire,Migrations,Tests} ``` 2. Create `app/Mod/Blog/Boot.php`: ```php 'onWebRoutes', ]; public function onWebRoutes(WebRoutesRegistering $event): void { $event->routes(fn() => require __DIR__.'/Routes/web.php'); $event->views('blog', __DIR__.'/Views'); } } ``` 3. Create `app/Mod/Blog/Routes/web.php`: ```php name('blog.index'); ``` 4. Create `app/Mod/Blog/Views/index.blade.php`: ```blade Blog

Welcome to the Blog

``` Visit http://localhost:8000/blog to see your module in action. ## Adding a Model Create `app/Mod/Blog/Models/Post.php`: ```php 'datetime', ]; } } ``` Create a migration in `app/Mod/Blog/Migrations/`: ```php id(); $table->string('title'); $table->string('slug')->unique(); $table->text('content'); $table->timestamp('published_at')->nullable(); $table->timestamps(); }); } public function down(): void { Schema::dropIfExists('posts'); } }; ``` Run the migration: ```bash php artisan migrate ``` ## Adding a Livewire Component Create `app/Mod/Blog/Livewire/PostListPage.php`: ```php Post::latest()->paginate(10), ]); } } ``` Update `app/Mod/Blog/Routes/web.php`: ```php name('blog.index'); ``` Create `app/Mod/Blog/Views/posts/index.blade.php`: ```blade

Blog Posts

@forelse ($posts as $post)

@empty

No posts yet.

@endforelse {{ $posts->links() }}

``` ## Writing Tests Create `app/Mod/Blog/Tests/PostTest.php`: ```php get('/blog') ->assertOk() ->assertSee('Blog Posts'); }); it('shows posts on the index page', function () { $post = Post::create([ 'title' => 'Test Post', 'slug' => 'test-post', 'content' => 'This is a test post.', ]); $this->get('/blog') ->assertOk() ->assertSee('Test Post'); }); ``` Run tests: ```bash vendor/bin/pest ``` ## Code Formatting Before committing, run Laravel Pint: ```bash # Format changed files only vendor/bin/pint --dirty # Format all files vendor/bin/pint ``` ## Next Steps - Read the [Architecture documentation](architecture.md) to understand the module system - Review [Security considerations](security.md) before deploying - Explore the [Core PHP Framework documentation](https://github.com/host-uk/core-php) - Add the Admin Panel with `host-uk/core-admin` - Build an API with `host-uk/core-api` ## Common Commands ```bash # Development php artisan serve # Start PHP server npm run dev # Start Vite with HMR npm run build # Build for production # Modules php artisan make:mod Name # Create a new module php artisan make:mod Name --all # With all features # Database php artisan migrate # Run migrations php artisan migrate:fresh # Reset and re-run migrations php artisan db:seed # Run seeders # Testing vendor/bin/pest # Run all tests vendor/bin/pest --filter=Name # Run specific test # Code Quality vendor/bin/pint # Format code vendor/bin/pint --test # Check formatting without changes ```

Welcome to the Blog

Blog Posts

{{ $post->title }}