diff --git a/Changelog.md b/Changelog.md index b0ffcb5..ebfe8ed 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,7 +1,7 @@ # AppShell Changelog -## 4.x-dev -#### 2024-XX-YY +## 4.0.0 +##### 2024-07-04 - BC: Added the `supportedIcons()` static method to the `IconTheme` interface - BC: Upgrade to Bootstrap 5.3 diff --git a/README.md b/README.md index 5c5a801..970766b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Konekt AppShell -[![Backend Tests](https://img.shields.io/github/actions/workflow/status/artkonekt/appshell/tests.yml?branch=master&label=backend&style=flat-square)](https://github.com/artkonekt/appshell/actions?query=workflow%3Atests) -[![Frontend Tests](https://img.shields.io/github/actions/workflow/status/artkonekt/appshell/frontend.yml?branch=master&label=frontend&style=flat-square)](https://github.com/artkonekt/appshell/actions?query=workflow%3AFrontend) +[![Backend Tests](https://img.shields.io/github/actions/workflow/status/artkonekt/appshell/tests.yml?branch=4.x&label=backend&style=flat-square)](https://github.com/artkonekt/appshell/actions?query=workflow%3Atests) +[![Frontend Tests](https://img.shields.io/github/actions/workflow/status/artkonekt/appshell/frontend.yml?branch=4.x&label=frontend&style=flat-square)](https://github.com/artkonekt/appshell/actions?query=workflow%3AFrontend) [![Packagist Stable Version](https://img.shields.io/packagist/v/konekt/appshell.svg?style=flat-square&label=stable)](https://packagist.org/packages/konekt/appshell) [![StyleCI](https://styleci.io/repos/74504388/shield?branch=master)](https://styleci.io/repos/74504388) [![Packagist downloads](https://img.shields.io/packagist/dt/konekt/appshell.svg?style=flat-square)](https://packagist.org/packages/konekt/appshell) diff --git a/docs/installation.md b/docs/installation.md index 4f14d43..ad8e173 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -4,21 +4,14 @@ ## Requirements -As of AppShell v3.10, the requirements are: +As of AppShell v4.0, the requirements are: -- PHP 8.0 - 8.3 -- Laravel 9.x, 10.x +- PHP 8.2 - 8.3 +- Laravel 10.x, 11.x ## Install AppShell -Either create a new Laravel project: - -```bash -composer create-project laravel/laravel myapp -cd myapp -``` - -.. or go to an existing Laravel 9+ application's root folder and launch these commands: +Either create a new Laravel project or go to an existing Laravel 10+ application's root folder and launch these commands: ```bash composer require konekt/appshell @@ -51,7 +44,7 @@ Now you should see this: +----+---------------------+------+----------+------------------+-----------------+ | # | Name | Kind | Version | Id | Namespace | +----+---------------------+------+----------+------------------+-----------------+ -| 1. | Konekt AppShell Box | Box | 3.10.0 | konekt.app_shell | Konekt\AppShell | +| 1. | Konekt AppShell Box | Box | 4.0.0 | konekt.app_shell | Konekt\AppShell | +----+---------------------+------+----------+------------------+-----------------+ ``` @@ -71,14 +64,14 @@ AppShell (with the underlying modules) contains ~20 migrations out of the box. ### Auth Scaffolding -> Laravel, with the release of version 6 has significantly changed the way of auth scaffolding. -> For details, refer to [Laravel Authentication Docs](https://laravel.com/docs/6.x/authentication#authentication-quickstart). +Depending on your needs, Laravel offers you several starter kits for authentication: https://laravel.com/docs/11.x/starter-kits -If you haven't done it yet, install the Laravel UI package: +As a reference, here we're showing you how to install breeze with blade, but you can choose any other solution you like. ```bash -composer require laravel/ui -php artisan ui:auth +composer require laravel/breeze --dev + +php artisan breeze:install ``` ### The User Model @@ -196,7 +189,7 @@ Since this package will be built along with your application, it's assets need t **2. Install the following npm packages:** ```bash -npm add bootstrap@4.6 jquery alpinejs@3.10 popper.js +npm add bootstrap@5.3 alpinejs@3.10 popper.js ``` **3. Compile the assets with mix:** `npm run dev` diff --git a/docs/upgrade.md b/docs/upgrade.md index 8c480d7..b65465f 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -2,8 +2,6 @@ ## 3.x -> 4.0 -> ⚠ AppShell v4 IS STILL WORK IN PROGRESS and HAS NOT BEEN RELEASED YET! (Coming in Q3 2023) - ## Group Component Has Been Renamed To Card Additionally, the component's `actionbar` slot has been renamed to `actions` diff --git a/src/resources/manifest.php b/src/resources/manifest.php index eee5e20..a66664f 100644 --- a/src/resources/manifest.php +++ b/src/resources/manifest.php @@ -4,5 +4,5 @@ return [ 'name' => 'AppShell', - 'version' => '4.x-dev' + 'version' => '4.0.0' ];