Skip to content

Commit c719f3a

Browse files
author
Reza Ahmed
committed
Initail release
1 parent 8a5711b commit c719f3a

221 files changed

Lines changed: 12569 additions & 26 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 55 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,55 @@
1-
# AimAdmin - Laravel Admin Panel for Streamlined Development
2-
Welcome to AimAdmin, the ultimate Laravel admin panel plugin engineered to elevate developers' productivity and streamline development workflows. AimAdmin empowers Laravel developers to concentrate exclusively on crafting domain-specific features and functionalities by abstracting away the complexities of building admin UI/UX and common CRUD functionality. With seamless integration and an intuitive interface, AimAdmin accelerates project development without compromising quality or flexibility.
3-
# Key Benefits for Laravel Developers
4-
- **Effortless Integration:** Seamlessly integrate AimAdmin into your Laravel application with minimal setup and configuration overhead.
5-
- **Time-Saving:** Bid farewell to repetitive tasks. Focus your efforts on building core application features while AimAdmin handles administrative tasks efficiently.
6-
- **Customization Made Easy:** Tailor AimAdmin to fit your project requirements effortlessly. Enjoy flexibility for customization without sacrificing simplicity.
7-
- **Robust Functionality:** Explore a comprehensive suite of features, including user management, role-based access control, content management, and more, readily available out of the box.
8-
- **Enhanced Productivity:** Streamline your development process and expedite project delivery with AimAdmin's ready-to-use admin panel solution.
9-
# Get Started
10-
1. Clone the AimAdmin repository.
11-
2. Install dependencies via Composer.
12-
3. Configure your environment variables.
13-
4. Run migrations and seeders.
14-
5. Dive into crafting your application's unique features while AimAdmin handles administrative tasks seamlessly!
15-
16-
# Contributions
17-
Join our vibrant community of developers and contribute to making Laravel development even more efficient and accessible. Whether it's through bug fixes, feature enhancements, or documentation improvements, your contributions to AimAdmin are valued and appreciated.
1+
![Aim-Admin](https://github.com/user-attachments/assets/07112a33-3179-4b49-a625-8fe5b47ad900)
2+
3+
![php-laravel](https://github.com/user-attachments/assets/a146f866-bbfc-4b65-939b-d36fe572227c)
4+
![developed-by-codecoz](https://github.com/user-attachments/assets/041fa195-e167-4b5f-97a7-0d7abf54e26f)
5+
6+
[![Latest Version](https://img.shields.io/packagist/v/codecoz/aim-admin?color=blue&label=release&style=for-the-badge)](https://packagist.org/packages/codecoz/aim-admin)
7+
[![Stars](https://img.shields.io/github/stars/codecoz/aim-admin?color=rgb%2806%20189%20248%29&label=stars&style=for-the-badge)](https://packagist.org/packages/codecoz/aim-admin)
8+
[![Total Downloads](https://img.shields.io/packagist/dt/codecoz/aim-admin.svg?color=rgb%28249%20115%2022%29&style=for-the-badge)](https://packagist.org/packages/codecoz/aim-admin)
9+
[![Forks](https://img.shields.io/github/forks/codecoz/aim-admin?color=rgb%28134%20115%2022%29&style=for-the-badge)](https://packagist.org/packages/codecoz/aim-admin)
10+
[![Issues](https://img.shields.io/github/issues/codecoz/aim-admin?color=rgb%28134%20239%20128%29&style=for-the-badge)](https://packagist.org/packages/codecoz/aim-admin)
11+
12+
13+
# AIM Admin 🎉
14+
<br>
15+
A comprehensive Laravel package designed to simplify admin tasks and develop enterprise web applications. With a robust, flexible, and feature-rich admin dashboard, it promotes best coding practices, following SOLID principles for enhanced code readability, maintainability, and extensibility.
16+
17+
<br>
18+
19+
##
20+
**Boost Laravel Development with Aim Admin**
21+
22+
Aim Admin is a powerful Laravel package designed to simplify admin dashboard development. It empowers you to rapidly build and manage data-driven interfaces with its built-in CRUD generator, eliminating the need for extensive boilerplate code.
23+
24+
**Key Features:**
25+
26+
* **Effortless CRUD Generation:** Generate complete CRUD (Create, Read, Update, Delete) operations for your database models in a single command, saving you time and effort.
27+
##
28+
* **Elegant Admin Interface:** Leverage the popular AdminLTE template for a visually appealing and user-friendly admin dashboard experience.
29+
##
30+
* **Best Coding Practices:** Aim Admin promotes Laravel's best practices and coding standards, ensuring your applications are maintainable and scalable.
31+
##
32+
* **Flexible Customization:** Easily tailor the generated code and interface to perfectly match your specific project requirements.
33+
##
34+
* **Highly Extensible:** Benefit from Laravel's modular architecture to extend Aim Admin's functionality and integrate with other third-party libraries.
35+
36+
##
37+
**Installation:**
38+
39+
```bash
40+
composer require codecoz/aim-admin
41+
```
42+
43+
**Documentation:**
44+
45+
For detailed usage instructions and examples, please refer to the comprehensive documentation: https://codecoz.com/aim-admin
46+
47+
##
48+
49+
**Contributing:**
50+
51+
We welcome contributions from the community! Please feel free to submit bug reports, feature requests, or pull requests.
52+
53+
**License:**
54+
55+
Aim Admin is licensed under the MIT License.

changelog.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
3+
All notable changes to `Admin` will be documented in this file.
4+
5+
## Version 1.0
6+
7+
### Added
8+
- Everything

composer.json

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"name": "codecoz/aim-admin",
3+
"description": "Welcome to AimAdmin, the ultimate Laravel admin panel plugin engineered to elevate developers' productivity and streamline development workflows.",
4+
"license": "MIT",
5+
"minimum-stability": "stable",
6+
"authors": [
7+
{
8+
"name": "CodeCoz",
9+
"email": "contact@codecoz.com",
10+
"homepage": "https://codecoz.com"
11+
}
12+
],
13+
"homepage": "https://codecoz.com",
14+
"keywords": [
15+
"Laravel",
16+
"Aim",
17+
"Admin"
18+
],
19+
"require": {
20+
"php": "^8.1",
21+
"illuminate/support": "~10|~11"
22+
},
23+
"require-dev": {
24+
"orchestra/testbench": "~9",
25+
"gajus/dindent": "^2.0",
26+
"phpunit/phpunit": "^10.0"
27+
},
28+
"autoload": {
29+
"psr-4": {
30+
"CodeCoz\\AimAdmin\\": "src/"
31+
}
32+
},
33+
"autoload-dev": {
34+
"psr-4": {
35+
"CodeCoz\\AimAdmin\\Tests\\": "tests/"
36+
}
37+
},
38+
"extra": {
39+
"laravel": {
40+
"providers": [
41+
"CodeCoz\\AimAdmin\\AdminServiceProvider"
42+
],
43+
"aliases": {
44+
"Admin": "CodeCoz\\AimAdmin\\Facades\\Admin"
45+
}
46+
}
47+
}
48+
}

config/aim-admin.php

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
<?php
2+
3+
return [
4+
/* --------------------------------------------------------------------------------------------
5+
* Menu Configuration
6+
* --------------------------------------------------------------------------------------------
7+
*/
8+
'menu_filters' => [
9+
CodeCoz\AimAdmin\MenuBuilder\Filters\HrefFilter::class,
10+
CodeCoz\AimAdmin\MenuBuilder\Filters\ActiveFilter::class,
11+
CodeCoz\AimAdmin\MenuBuilder\Filters\ClassesFilter::class,
12+
],
13+
14+
'menu' => [
15+
// Navbar items:
16+
[
17+
'text' => 'Dashboard',
18+
'icon' => 'ti ti-home',
19+
'url' => 'dashboard'
20+
],
21+
22+
[
23+
'text' => 'Support 1',
24+
'url' => '#',
25+
'icon' => 'ti ti-help',
26+
'active' => ['support1'],
27+
'submenu' => [
28+
[
29+
'text' => 'Ticket',
30+
'url' => 'support1',
31+
'icon' => 'ti ti-article',
32+
]
33+
],
34+
],
35+
36+
[
37+
'text' => 'Support 2',
38+
'url' => '#',
39+
'icon' => 'ti ti-help',
40+
'active' => ['support2'],
41+
'submenu' => [
42+
[
43+
'text' => 'Ticket',
44+
'url' => 'support2',
45+
'icon' => 'ti ti-article',
46+
]
47+
],
48+
],
49+
50+
[
51+
'text' => 'Support 3',
52+
'url' => '#',
53+
'icon' => 'ti ti-help',
54+
'active' => ['support3'],
55+
'submenu' => [
56+
[
57+
'text' => 'Ticket',
58+
'url' => 'support3',
59+
'icon' => 'ti ti-article',
60+
]
61+
],
62+
],
63+
64+
],
65+
66+
/* --------------------------------------------------------------------------------------------
67+
* File Upload Configuration
68+
* --------------------------------------------------------------------------------------------
69+
*/
70+
'upload_file_type' => ['png', 'jpg', 'bmp', 'pdf', 'doc', 'xls', 'ppt'],
71+
'upload_file_size' => 5 * 1024,
72+
73+
/* --------------------------------------------------------------------------------------------
74+
* Auth Configuration
75+
* --------------------------------------------------------------------------------------------
76+
*/
77+
'auth' => [
78+
'controller' => \CodeCoz\AimAdmin\Http\Controllers\Auth\LoginController::class,
79+
'user_model' => \App\Models\User::class,
80+
'url' => 'login',
81+
'logout_url' => 'logout',
82+
'profile_url' => 'profile',
83+
'middleware' => ['guest', 'web'],
84+
],
85+
'registration' => [
86+
'controller' => \CodeCoz\AimAdmin\Http\Controllers\Auth\RegistrationController::class,
87+
'fields' => [
88+
'number' => 'id',
89+
'text' => 'full_name'
90+
]
91+
],
92+
'back_to_top' => true,
93+
'layout_class' => [
94+
'body' => 'text-sm',
95+
'brand' => '',
96+
'sidebar' => '',
97+
'navbar' => '',
98+
'footer' => '',
99+
],
100+
'footer_text' => 'Anything you want',
101+
//Toast Time
102+
'flash-timer' => 2000,
103+
'show_toast_error' => true,
104+
'show_inline_alert_box' => true,
105+
'inline_validation_error' => true
106+
];

contributing.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing
2+
3+
Contributions are welcome and will be fully credited.
4+
5+
Contributions are accepted via Pull Requests on [Github](https://github.com/codecoz/aim-admin).
6+
7+
# Things you could do
8+
If you want to contribute but do not know where to start, this list provides some starting points.
9+
- Add license text
10+
- Remove rewriteRules.php
11+
- Set up TravisCI, StyleCI, ScrutinizerCI
12+
- Write a comprehensive ReadMe
13+
14+
## Pull Requests
15+
16+
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
17+
18+
- **Document any change in behaviour** - Make sure the `readme.md` and any other relevant documentation are kept up-to-date.
19+
20+
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
21+
22+
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
23+
24+
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
25+
26+
27+
**Happy coding**!
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<?php
2+
3+
use Illuminate\Database\Migrations\Migration;
4+
use Illuminate\Database\Schema\Blueprint;
5+
use Illuminate\Support\Facades\Schema;
6+
7+
return new class extends Migration
8+
{
9+
/**
10+
* Run the migrations.
11+
*/
12+
public function up(): void
13+
{
14+
Schema::create('users', function (Blueprint $table) {
15+
$table->id();
16+
$table->string('name');
17+
$table->string('email')->unique();
18+
$table->timestamp('email_verified_at')->nullable();
19+
$table->string('password');
20+
$table->rememberToken();
21+
$table->timestamps();
22+
});
23+
24+
Schema::create('password_reset_tokens', function (Blueprint $table) {
25+
$table->string('email')->primary();
26+
$table->string('token');
27+
$table->timestamp('created_at')->nullable();
28+
});
29+
30+
Schema::create('sessions', function (Blueprint $table) {
31+
$table->string('id')->primary();
32+
$table->foreignId('user_id')->nullable()->index();
33+
$table->string('ip_address', 45)->nullable();
34+
$table->text('user_agent')->nullable();
35+
$table->longText('payload');
36+
$table->integer('last_activity')->index();
37+
});
38+
}
39+
40+
/**
41+
* Reverse the migrations.
42+
*/
43+
public function down(): void
44+
{
45+
Schema::dropIfExists('users');
46+
Schema::dropIfExists('password_reset_tokens');
47+
Schema::dropIfExists('sessions');
48+
}
49+
};

docs/contents/form.md

Whitespace-only changes.

docs/index.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

license.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# The license
2+
3+
Copyright (c) Md Abdullah Ibne Masud <contact@codecoz.com>
4+
5+
...Add your license text here...

phpunit.xml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
3+
<testsuites>
4+
<testsuite name="Package">
5+
<directory suffix=".php">./tests/Components</directory>
6+
<directory suffix=".php">./tests/Service</directory>
7+
</testsuite>
8+
</testsuites>
9+
<source>
10+
<include>
11+
<directory>src/</directory>
12+
</include>
13+
</source>
14+
</phpunit>

0 commit comments

Comments
 (0)