Skip to content

Feature/update readme #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
green-onions wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Feature/update readme #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8d1067e
update of the README file
green-onions Oct 27, 2020
9915ffd
update of the README file
green-onions Oct 27, 2020
cb5d0de
Update README.md
green-onions Oct 27, 2020
f9df211
Update README.md
green-onions Oct 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.idea/
.DS_Store
135 changes: 99 additions & 36 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,56 +1,51 @@
<p align="center">
<a href="http://www.aropixel.com/">
<img src="https://avatars1.githubusercontent.com/u/14820816?s=200&v=4" alt="Aropixel logo" width="75" height="75" style="border-radius:100px">
</a>
</p>
![Aropixel Logo](Resources/public/logo-aropixel.png)

# Aropixel Admin Bundle

<h1 align="center">Aropixel Admin Bundle</h1>

<p>
Aropixel Admin Bundle is a bootstrap admin bundle for your Symfony 4 projects. It provides a minimalist admin system with: login, logout, admin users crud, admin menu management.<br />
You can plug <a href="https://github.com/aropixel">compatible bundles</a> to manage:
<ul>
<li><a href="https://github.com/aropixel/blog-bundle">blog</a> content</li>
<li><a href="https://github.com/aropixel/page-bundle">pages</a> of your website</li>
<li><a href="https://github.com/aropixel/menu-bundle">menus</a> of your website</li>
<li>store and send incoming <a href="https://github.com/aropixel/menu-bundle">contacts</a> of your website</li>
</ul>
</p>
Aropixel Admin Bundle is a Bootstrap admin bundle for your Symfony 4/5 projects. It provides a minimalist admin system with: login, logout, admin users crud, admin menu management.
<br><br>
You can plug additional compatible bundles to manage your admin system:

- Blog content with [Aropixel Blog Bundle](https://github.com/aropixel/blog-bundle)
- The pages of your website with [Aropixel Page Bundle](https://github.com/aropixel/page-bundle)
- The menus of your website with [Aropixel Menu Bundle](https://github.com/aropixel/menu-bundle)
- Store and send incoming contacts with [Aropixel Contact Bundle](https://github.com/aropixel/contact-bundle)

![GitHub last commit](https://img.shields.io/github/last-commit/aropixel/admin-bundle.svg)
[![GitHub issues](https://img.shields.io/github/issues/aropixel/admin-bundle.svg)](https://github.com/stisla/stisla/issues)
[![License](https://img.shields.io/github/license/aropixel/admin-bundle.svg)](LICENSE)

![Aropixel Admin Preview](./screenshot.png)


## Table of contents

- [Quick start](#quick-start)
- [License](#license)


## Quick start

- Create your symfony 4 project
- Require Aropixel Admin Bundle : `composer require aropixel/admin-bundle`
- Create your Symfony project. A few more steps and you'll be good to go !

- Require Aropixel Admin Bundle: `composer require aropixel/admin-bundle`

- If you get a "knplabs/knp-paginator-bundle" error, downgrade twig to version 2: `composer require twig/twig ^2.0` and re-install the AdminBundle

- Apply migrations
- Create a "aropixel.yaml" file in config folder and configure according to you need:
````

- Create a **aropixel.yaml** file in your config/packages folder and configure it according to your needs:
```yaml
aropixel_admin:
client:
name: "aropixel client"
name: "Your Client Name"
copyright:
name: "Aropixel"
link: "http://www.aropixel.com"
theme:
menu_position: left
````
- Configure the security.yaml:
````
```

- Configure the **security.yaml** (you can copy and paste this one):
```yaml
security:

providers:
Expand Down Expand Up @@ -103,18 +98,86 @@ security:
- { path: ^/admin/login$, role: IS_AUTHENTICATED_ANONYMOUSLY }
- { path: ^/admin/, role: ROLE_ADMIN }

````
- Include the routes:
````
```

- Create another **aropixel.yaml** file in config/packages/routes folder and include the routes:
```yaml
aropixel_admin:
resource: '@AropixelAdminBundle/Resources/config/routing/aropixel.yml'
prefix: /admin

````
- Create your first admin access : php bin/console aropixel:admin:setup

- Add the ConfigureMenuListener class in App Folder and register it as service

```

- In order to manage the menu of your admin system, you now need to create a new event listener.
This file will also be needed if you use other bundles from Aropixel.
It must be called **ConfigureMenuListener** and look like that:
```php
<?php

namespace App\EventListener;

use Aropixel\AdminBundle\Event\ConfigureMenuEvent;
use Aropixel\AdminBundle\Menu\AbstractMenuListener;

class ConfigureMenuListener extends AbstractMenuListener
{
/**
* @param ConfigureMenuEvent $event
*/
public function onMenuConfigure(ConfigureMenuEvent $event)
{
$request = $this->requestStack->getCurrentRequest();
$this->factory = $event->getFactory();
$this->em = $event->getEntityManager();
$this->routeName = $request->get('_route');
$this->routeParameters = $request->get('_route_params');

$this->menu = $event->getAppMenu('main');
if (!$this->menu) {
$this->menu = $this->createRoot();
}

// To add an item to the navigation bar of your admin
// system, you'll need to indicate a name, a route
// in your admin system and a Fontawesome class as follow :

$this->addItem("Dashboard", "_admin", "fas fa-home");

// You can also add some categories to put the items
// as it is done here for managing the users :

$this->addCategory("Administration");
$this->addItem("Users", "user_index", "fas fa-users");

// Another option is to create some group items to put them
// as one item with a dropdown :

// $groupItem = $this->createGroupItem("Pages", "fas fa-file");
// $this->addSubItem($groupItem, 'Homepage', ['route' => 'homepage', 'routeParameters' => ['type' => 'homepage']]);
// $this->addSubItem($groupItem, 'Contacts', ['route' => 'contacts', 'routeParameters' => ['type' => 'contacts']]);
// $this->addGroupItem($groupItem);

// Do not remove this line
$event->addAppMenu($this->menu, false, 'main');
}
}
```
- Once your event listener created, add it to your **services.yaml** (careful with the indentation):
```yaml
App\EventListener\ConfigureMenuListener:
tags:
- { name: kernel.event_listener, event: aropixel.admin_menu_configure, method: onMenuConfigure }
```

<br>

- You're all set 🎉 ! You can create your first admin access using
`php bin/console aropixel:admin:setup` and go to the route /admin to start
working on your project and manage your users.

<br>

Cool, but not enough ? Check the others
[Aropixel bundles](https://github.com/aropixel/) to optimise your admin system !

## License
Aropixel Admin Bundle is under the [MIT License](LICENSE)
Binary file added Resources/public/logo-aropixel.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.