https://github.com/zofe/rapyd-admin
rapid laravel components, modules, application boilerplate
https://github.com/zofe/rapyd-admin
Last synced: 12 months ago
JSON representation
rapid laravel components, modules, application boilerplate
- Host: GitHub
- URL: https://github.com/zofe/rapyd-admin
- Owner: zofe
- License: mit
- Created: 2024-03-16T17:30:20.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-29T10:50:50.000Z (about 1 year ago)
- Last Synced: 2025-05-03T12:36:48.352Z (12 months ago)
- Language: CSS
- Size: 12.2 MB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Rapyd Admin: Simplifying Laravel Development
[](https://rapyd.dev/demo)
## Installation
Create new laravel app then install rapyd-admin package.
(answer “y” to the question about writes "allow-plugins" to composer.json)
```bash
composer create-project --prefer-dist laravel/laravel myapp
cd myapp
composer require zofe/rapyd-admin
```
Then you can customize roles & permissions in app/Modules/Auth/permissions.php then run
```bash
php artisan rpd:make:setup
#then you can serve the app with
php artisan serve
```
Now you can login with a default admin user:
```
admin@laravel
admin
```
---
## Rapyd Admin
Rapyd Admin enhances Laravel by offering essential admin features with modular approach:
- **BALL Stack Environment:** Bundles Bootstrap CSS, Alpine.js, Laravel, and Livewire for a quick boilerplate.
- **Layout Module:** Classic sidebar/navbar design based on SBAdmin 3, updated to Bootstrap 5.3 with customizable SCSS and a variety of blade anonymous components for standardized, extendable frontends.
- **Auth Module:** Robust authentication with socialite integration, Fortify, 2FA, and role/permission management.
- **Custom Modules:** Structured handling of components and modules, REST API endpoints, and more, with an emphasis on reusable, encapsulated code for cleaner organization and maintainability.
## Generators
Rapyd has some commands to generate models, components, modules (bundled components & views isolated in a folder) via artisan command line:
### Models
generate a model (via command line)
```bash
php artisan rpd:make:model {ModelName}
# example
php artisan rpd:make:model Article
```
### Livewire components
```bash
php artisan rpd:make {ComponentName} {Model}
# example
php artisan rpd:make UserTable User
```
will generate
```
laravel/
├─ app/
│ ├─ Livewire/
│ │ ├─ UserTable.php
│ resources/
│ │ ├─ views/
│ │ │ ├─livewire/
│ │ │ │ ├─ user_table.php
```
## Modules & Generators
example of out of the box module structure you can use after installing rapyd-admin.
```bash
php artisan rpd:make {ComponentsName} {Model} --module={module}
# example
php artisan rpd:make Articles Article --module=Blog
```
- Will create `Blog` folder in you app/Modules directory.
- Three livewire components in the `Livewire` subfolder (ArticlesEdit, ArticlesTable, ArticlesView)
- Three blade components in the `Views` subfolder (articles_edit, articles_table, articles_view)
- Inside your Module folder you can reply (if needed) the laravel application folder structure (controllers, migrations, jobs, etc..)
```
laravel/
├─ app/
│ ├─ Modules/
│ │ ├─ Blog/
│ │ │ ├─ Livewire/
│ │ │ │ ├─ ArticlesEdit.php
│ │ │ │ ├─ ArticlesTable.php
│ │ │ │ ├─ ArticlesView.php
│ │ │ ├─ Views/
│ │ │ │ ├─ articles_edit.blade.php
│ │ │ │ ├─ articles_table.blade.php
│ │ │ │ ├─ articles_view.blade.php
│ │ │ ├─ routes.php
```
---
## Blade views and Components
### Table
A Table is a "listing component" with these features:
- "input filters" to search in a custom data set
- "buttons" (for example "add" record or "reset" filters)
- "pagination links"
- "sort links"
you can generate a Table component with:
```bash
php artisan rpd:make ArticlesTable Article
```
or and entire crud (Table/View/Edit) in a module named Blog with;
```bash
php artisan rpd:make Articles Article --module=Blog
```
Generated & Customized view can be something like:
```bash
# articles_view.blade.php
```html
title
author
body
@foreach ($items as $article)
{{ $article->id }}
{{ $article->title }}
{{ $article->author->firstname }}
{{ Str::limit($article->body,50) }}
@endforeach
```
props
- `title`: the heading title for this crud
content/slots
- should be a html table that loops model $items
- `buttons`: buttons panel
example: [rapyd.dev/demo/articles](https://rapyd.dev/demo/articles)
---
### View
a View is a "detail page component" with :
- "buttons" slot (for example back to "list" or "edit" current record)
- "actions" any link that trigger a server-side
```html
Title: {{ $article->title }}
Author: {{ $article->author->firstname }} {{ $model->author->lastname }}
```
props
- `title`: the heading title for this crud
content/slots
- should be a detail of $model
- `buttons`: buttons panel
- `actions`: buttons panel
example: [rapyd.dev/demo/article/view/1](https://rapyd.dev/demo/article/view/1)
---
### Edit
Edit is a "form component" usually binded to a model with:
- "buttons" and "actions" (undo, save, etc..)
- form "fields"
- automatic errors massages / rules management
```html
```
props
- `title`: the heading title for this crud
content/slots
- form fields binded with public/model properties
example: [rapyd.dev/demo/article/edit/1](https://rapyd.dev/demo/article/edit/1)
---
### Fields
inside some widget views you can drastically semplify the syntax using
predefined blade components that interacts with livewire
```html
```
```html
```
```html
or
```
```html
```
```html
```
```html
```
props
- `label`: label to display above the input
- `placeholder`: placeholder to use for the empty first option
- `model`: Livewire model property key
- `options`: array of options e.g. (used in selects)
- `debounce`: Livewire time in ms to bind data on keyup
- `lazy`: Livewire bind data only on change
- `prepend`: addon to display before input, can be used via named slot
- `append`: addon to display after input, can be used via named slot
- `help`: helper label to display under the input
- `icon`: Font Awesome icon to show before input e.g. `cog`, `envelope`
- `size`: Bootstrap input size e.g. `sm`, `lg`
- `rows`: rows nums
- `multiple`: allow multiple option selection (used in select-list)
- `endpoint`: a remote url for fetch optioms (used in select-list)
- `format`: the client-side field format (used in date and date-time)
- `value-format`: the server-side field value format (used in date and date-time)
## special tags
```html
```
## navigation
Nav Tabs: bootstrap nav-link menu with self-determined active link
```html
```
Nav Items: boostrap vertical menu items / single or grouped (collapsed)
```html
```
Nav Sidebar: bootstrap sidebar with self-determined or segment-based active link
```html
```
## Credits
- [Felice Ostuni](https://github.com/zofe)
- [All Contributors](../../contributors)
Inspirations:
- [rapyd-laravel](https://github.com/zofe/rapyd-laravel) my old laravel library (150k downloads)
- [livewire](https://livewire.laravel.com/) widely used "full-stack framework" to compose laravel application by widgets
- [laravel-bootstrap-components](https://github.com/bastinald/laravel-bootstrap-components) smart library which reduced the complexity of this one
## License & Contacts
Rapyd is licensed under the [MIT license](http://opensource.org/licenses/MIT)
Please join me and review my work on [Linkedin](https://www.linkedin.com/in/feliceostuni/)
thanks