# Getting Started

Welcome to the wiki for the Laravel K-framework package.

This guide will help you understand the basics of the Laravel K-framework, a powerful toolset designed to streamline development processes and enhance productivity within the Laravel ecosystem. Whether you're a beginner or an experienced developer, this resource will provide the foundational knowledge needed to effectively utilize the package.

Why this matters: the framework gives you ready-made Blade components, form helpers, and UI scaffolding, so you spend less time wiring Bootstrap/JS and more time building features.

**How to read this wiki:** start with installation, then skim the UI basics to understand layout and config, then learn the component pattern once in components/basics, and finally dive into specific forms, visuals, or utilities as you need them.

Learning path:

1. [Installation Guide](readme/installation.md) — install and run `php artisan kfw:update`.
2. [UI basics and config](readme/usage/styling/basics.md) — set up layout, theme, and navigation.
3. [How to use components and standard attributes](readme/usage/components/basics.md) — learn class `::make()` once, reuse everywhere.
4. Forms (`readme/usage/components/forms/form.md`) and visuals (`readme/usage/components/visuals/card.md`) — build pages.
5. [Usage](readme/usage.md) utilities — frontend helpers and backend helpers (API, resources, cloner) as needed.

Quick taste of the pattern you will see everywhere — build with class `::make()` in controller and echo in Blade, or call fully-qualified class directly in Blade:

Build in controller:

```php
use KFramework\Components\Visual\Alert;

public function show()
{
    $alert = Alert::make()->setContent('Welcome to K-Framework!');

    return view('demo', compact('alert'));
}
```

Echo in Blade:

```php
{!! $alert !!}
{!! \KFramework\Components\Visual\Alert::make()->setContent('Welcome to K-Framework!') !!}
```

---

## Table of Contents

1. ### [Installation Guide](readme/installation.md)

   Installing instructions for adding assets and a base layout to your app layout, ensuring a seamless integration into your project.

2. ### [Dependencies](readme/dependencies.md)

   Simple list of integrated packages used to make the framework run, detailing the essential components that power its functionality.

3. ### [Usage](readme/usage.md)

    How to apply and use framework components, helpers, and resources in your views, controllers, or models to build robust applications efficiently.

---

**See also / Next steps:** if you are new, go to [Installation Guide](readme/installation.md) first, then [Usage](readme/usage.md) for the full map of UI, components, and utilities. For dependencies background, see [Dependencies](readme/dependencies.md).