Merge pull request #18 from skn-036/noman

version 2 with laravel 10 & vue 3, entire rework

Author: skn-036

.editorconfig

@@ -3,13 +3,16 @@ root = true
 [*]
 charset = utf-8
 end_of_line = lf
-insert_final_newline = true
-indent_style = space
 indent_size = 4
+indent_style = space
+insert_final_newline = true
 trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
 
 [*.{yml,yaml}]
 indent_size = 2
+
+[docker-compose.yml]
+indent_size = 4

.env.example

@@ -1,10 +1,11 @@
 APP_NAME=Laravel
 APP_ENV=local
-APP_KEY=base64:UrQfqSTf3hsGIcldX1Y/bsO6WVLThXETt1GHZPKrq/0=
+APP_KEY=base64:BNRn58cujolcMCmBtdjN/8TLExrxoDQUBmiKw8h/p1o=
 APP_DEBUG=true
-APP_URL=http://localhost
+APP_URL=http://127.0.0.1:8000
 
 LOG_CHANNEL=stack
+LOG_DEPRECATIONS_CHANNEL=null
 LOG_LEVEL=debug
 
 DB_CONNECTION=mysql
@@ -16,11 +17,10 @@ DB_PASSWORD=
 
 BROADCAST_DRIVER=log
 CACHE_DRIVER=file
+FILESYSTEM_DISK=local
 QUEUE_CONNECTION=sync
-SESSION_DRIVER=cookie
-SESSION_LIFETIME=600
-SESSION_DOMAIN="null"
-SANCTUM_STATEFUL_DOMAINS="127.0.0.1:8000"
+SESSION_DRIVER=file
+SESSION_LIFETIME=120
 
 MEMCACHED_HOST=127.0.0.1
 
@@ -29,23 +29,33 @@ REDIS_PASSWORD=null
 REDIS_PORT=6379
 
 MAIL_MAILER=smtp
-MAIL_HOST=mailhog
+MAIL_HOST=mailpit
 MAIL_PORT=1025
 MAIL_USERNAME=null
 MAIL_PASSWORD=null
 MAIL_ENCRYPTION=null
-MAIL_FROM_ADDRESS=null
+MAIL_FROM_ADDRESS="hello@example.com"
 MAIL_FROM_NAME="${APP_NAME}"
 
 AWS_ACCESS_KEY_ID=
 AWS_SECRET_ACCESS_KEY=
 AWS_DEFAULT_REGION=us-east-1
 AWS_BUCKET=
+AWS_USE_PATH_STYLE_ENDPOINT=false
 
 PUSHER_APP_ID=
 PUSHER_APP_KEY=
 PUSHER_APP_SECRET=
+PUSHER_HOST=
+PUSHER_PORT=443
+PUSHER_SCHEME=https
 PUSHER_APP_CLUSTER=mt1
 
-MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
-MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
+SANCTUM_STATEFUL_DOMAINS=127.0.0.1:8000
+
+VITE_APP_NAME="${APP_NAME}"
+VITE_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
+VITE_PUSHER_HOST="${PUSHER_HOST}"
+VITE_PUSHER_PORT="${PUSHER_PORT}"
+VITE_PUSHER_SCHEME="${PUSHER_SCHEME}"
+VITE_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

.gitattributes

@@ -1,5 +1,11 @@
-* text=auto
-*.css linguist-vendored
-*.scss linguist-vendored
-*.js linguist-vendored
+* text=auto eol=lf
+
+*.blade.php diff=html
+*.css diff=css
+*.html diff=html
+*.md diff=markdown
+*.php diff=php
+
+/.github export-ignore
 CHANGELOG.md export-ignore
+.styleci.yml export-ignore

.gitignore

@@ -1,13 +1,20 @@
+/.phpunit.cache
 /node_modules
+/public/build
 /public/hot
 /public/storage
+/storage/app
 /storage/*.key
 /vendor
 .env
 .env.backup
+.env.production
 .phpunit.result.cache
-docker-compose.override.yml
 Homestead.json
 Homestead.yaml
+auth.json
 npm-debug.log
 yarn-error.log
+/.fleet
+/.idea
+/.vscode

.prettierrc.json

@@ -0,0 +1,11 @@
+{
+	"plugins": ["@prettier/plugin-php"],
+	"tabWidth": 4,
+	"trailingComma": "all",
+	"arrowParens": "always",
+	"printWidth": 80,
+	"semi": true,
+	"singleQuote": true,
+	"singleAttributePerLine": true,
+	"vueIndentScriptAndStyle": false
+}

.styleci.yml

@@ -1,6 +1,6 @@
 ## About This Repository
 
-This repository uses PHP Laravel and Javascript Vue.js frameworks to implement Role Permissions management in CMS. Cookie based SPA authorization feature of Laravel Sanctum package is used to authorize the user inside the content management system. If a logged user has permission to do specific task, the link to visit the task and the page containing the task will be available to the logged user. Otherwise the page will be unavailable to the logged user with 401 unauthorized error even though try to access the route manually. This repo utilizes the SPA feature of Vue.js.
+This repository uses PHP Laravel version 10, Javascript Vue.js version 3 and Tailwind css frameworks to implement Role Permissions management in CMS. Vite is used to compile the frontend assets. Cookie based SPA authorization feature of Laravel Sanctum package is used to authorize the user inside the content management system. Vue router is used to handle the routing and Pinia is used as the frontend store management system. If a logged user has permission to do specific task, the link to visit the task and the page containing the task will be available to the logged user. Otherwise the page will be unavailable to the logged user with 401 unauthorized error even though try to access the route manually. Though some actions are visible on the frontend for better user experience, but it will handled on the backend and shows a error toast with relevant error message as well as permission requirements. This repo utilizes the SPA feature of Vue.js.
 
 ## Logging In
 
@@ -90,29 +90,37 @@ Following credentials can be used to log in the system
 </table>
 <br>
 
-Initailly only Super Admin is granted all the permissions. All other role has no permissions. To add permissions to any other role first log in as super admin, then visit all roles then role edit. Permissions can be attached or detached to any role from here.
+Initailly only Super Admin is granted all the permissions. All other role has no permissions. To add permissions to any other role, first log in as super admin, then go to the roles page. Assign necessary permissions to the role. Then come to the users page and update users roles. One user can have multiple roles. Overall user permissions will be the collection of all roles permissions combined. Super admin role is readonly(can not be edited or deleted). This role can not be applied to any other user. If a new permission is created, updated or deleted, it will be automatically applied to super admin.
 
 ## Installation
 
 First download this repository. Navigate to root of the project and then
+
 <pre>
     <code>composer install</code>
     <code>npm install</code>
 </pre>
 
 Copy the contents of .env.example to .env file. Fill up the database credentials(DB_DATABASE, DB_USERNAME, DB_PASSWORD) according to your database. At the root of your project run the following commands on terminal sequentially.
+
 <pre>
     <code>php artisan key:generate</code>
     <code>php artisan migrate</code>
     <code>php artisan db:seed</code>
 </pre>
 
-This will store all the default data into the database. Then compile the assets by
+This will store all the default data into the database. Then compile the assets and run development server by
+
 <pre>
     <code>npm run dev</code>
 </pre>
 
-Finally initiate your server and enjoy !!!
+Finally initiate your server on a new terminal and enjoy !!!
+
 <pre>
     <code>php artisan serve</code>
 </pre>
+
+## Api resource
+
+Postman collection for this repository can be found here in https://www.postman.com/cms-spa-036/workspace/cms-role-permission-laravel-vue

README.md

@@ -7,32 +7,18 @@
 
 class Kernel extends ConsoleKernel
 {
-    /**
-     * The Artisan commands provided by your application.
-     *
-     * @var array
-     */
-    protected $commands = [
-        //
-    ];
-
     /**
      * Define the application's command schedule.
-     *
-     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule
-     * @return void
      */
-    protected function schedule(Schedule $schedule)
+    protected function schedule(Schedule $schedule): void
     {
         // $schedule->command('inspire')->hourly();
     }
 
     /**
      * Register the commands for the application.
-     *
-     * @return void
      */
-    protected function commands()
+    protected function commands(): void
     {
         $this->load(__DIR__.'/Commands');
 

app/Console/Kernel.php

@@ -8,18 +8,9 @@
 class Handler extends ExceptionHandler
 {
     /**
-     * A list of the exception types that are not reported.
+     * The list of the inputs that are never flashed to the session on validation exceptions.
      *
-     * @var array
-     */
-    protected $dontReport = [
-        //
-    ];
-
-    /**
-     * A list of the inputs that are never flashed for validation exceptions.
-     *
-     * @var array
+     * @var array<int, string>
      */
     protected $dontFlash = [
         'current_password',
@@ -29,10 +20,8 @@ class Handler extends ExceptionHandler
 
     /**
      * Register the exception handling callbacks for the application.
-     *
-     * @return void
      */
-    public function register()
+    public function register(): void
     {
         $this->reportable(function (Throwable $e) {
             //