diff --git a/docs/README.md b/docs/README.md index 4fe0de66..f66b5293 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,6 +4,8 @@ The Sylius stack is a set of tools for your Symfony projects: * [Minimalist generic templates for your admin panels](admin-ui/getting-started.md) * [Build your Bootstrap admin panels with Sylius and Symfony UX](bootstrap-admin-ui/getting-started.md) +* [Resource management system, routing and CRUD operations](https://github.com/Sylius/SyliusResourceBundle/blob/1.13/docs/index.md) +* [Amazing grids with support of filters and custom fields integrated into Symfony](https://github.com/Sylius/SyliusGridBundle/blob/1.13/docs/index.md) * [Additional Twig extensions for your Symfony projects](twig-extra/getting-started.md) * [Composable Twig layouts](twig-hooks/getting-started.md) * [Basic UI translations](ui-translations/getting-started.md) diff --git a/docs/admin-ui/getting-started.md b/docs/admin-ui/getting-started.md index 675bf0c5..052a951b 100644 --- a/docs/admin-ui/getting-started.md +++ b/docs/admin-ui/getting-started.md @@ -1,6 +1,6 @@ --- description: >- - Admin UI contains minimalist generic templates for your admin panels. + Admin UI contains minimalist generic templates and routes for your admin panels. --- # Getting started @@ -12,3 +12,47 @@ Install the package using Composer and Symfony Flex: ```bash composer require sylius/admin-ui ``` + +## Basic routes + +- __Dashboard__ - sylius_admin_ui_dashboard +- __Login__ - sylius_admin_ui_login +- __LoginCheck__ - sylius_admin_ui_login_check +- __Logout__ - sylius_admin_ui_logout + +## Minimalist templates + +### Crud templates + +- crud/create.html.twig +- crud/index.html.twig +- crud/show.html.twig +- crud/update.html.twig + +*Usage with Sylius Resource package* + +```php +// src/Entity/Speaker.php + +namespace App\Entity; + +use Sylius\Resource\Metadata\AsResource; +use Sylius\Resource\Model\ResourceInterface; + +#[AsResource( + templatesDir: '@SyliusAdminUi/crud', +)] +class Speaker implements ResourceInterface +{ + // ... +} + +``` + +### Dashboard + +- dashboard/index.html.twig + +### Login + +- security/login.html.twig diff --git a/src/AdminUi/composer.json b/src/AdminUi/composer.json index fb49dad0..02d318b3 100644 --- a/src/AdminUi/composer.json +++ b/src/AdminUi/composer.json @@ -1,6 +1,6 @@ { "name": "sylius/admin-ui", - "description": "Minimalist generic templates for your admin panels", + "description": "Minimalist generic templates and routes for your admin panels", "type": "library", "require": { "php": "^8.1",