@extends('larasnap::layouts.app', ['class' => 'document guide']) @section('title','Guide') @section('content')

User Guide

Module: User Management
Functionalities:
  • Create User
  • View User
  • Edit User
  • Delete User
  • Assign Role to User
    • User can have multiple or single roles.
Module: Role Management
Functionalities:
  • Create Role
  • Edit Role
  • Delete Role
  • Assign Permission to Role
    • Role can have multiple or single permission.
  • Assign Screen to Role
    • Role can access multiple or single screen.
    • Screens are grouped based on the modules mapped.
Module: Role Management
Functionalities:
  • Create Permission
  • Edit Permission
  • Delete Permission
Module: Role Management
Functionalities:
  • Create Screen
  • Edit Screen
  • Delete Screen
  • Assign Role to Screen
    • Screen can be accessed by multiple or single roles.
    • Based on the configuration set, this provide screen based restriction and also hides the button(button to navigate to the restricted page) from the list or other pages.

Screen Name - Route Name(check routes/web.php file on the application)

User > Role > Screen relation
  • User Mapped to Role
  • Role Mapped to Screen
  • Screen Mapped to Role

Module field on the add/edit screen is used for mapping the screen to a module.

Module: Module Management
Functionalities:
  • Create Module
  • Edit Module
  • Delete Module
Module: Menu Management
Functionalities:
  • Create Menu
  • Edit Menu
  • Delete Menu
  • Assign Menu-Item to Menu
Module: Menu Management
Functionalities:
  • Add Menu-Item
  • Edit Menu-Item
  • Delete Menu-Item

Form Fields:

  • Link Type: Static URL/Dynamic Route
    • Static URL
    • Dynamic Route - Recommended only for developers. Its manadatory to add 'parameters' for the routes which requries parameters, missing the parameters or adding incorrect parameter will throw error in the application.
Module: Category Management
Functionalities:
  • Create Parent Category
  • Edit Parent Category
  • Delete Parent Category
  • Manage Child Category
  • Create Category
  • Edit Category
  • Delete Category

General settings of the application.

Refer LaraSnap Docs for complete user & developer documentation.

@endsection