Documentation

File Structure

Here is the general file structure of the template:

    app
    • Config
    • Controllers
    • Database
      • Migrations
      • Seeds
    • Filters
    • Helpers
    • Languages
    • Libraries
    • Models
    • ThirdParty
    • Views
  • gulp
  • node_modules
  • public

Modules Route

Here is the file structure of routes of the modules this files contains all the routes of respective modules.

      app
      • Config
        • Boot
        • App.php
        • Autoload.php
        • Cache.php
        • Constants.php
        • ContentSecurity.php
        • Cookie.php
        • CURLRequest.php
        • Database.php
        • DocTypes.php
        • Email.php
        • Encryption.php
        • Events.php
        • Exceptions.php
        • Feature.php
        • Filters.php
        • ForeignCharacters.php
        • Format.php
        • Generators.php
        • Honeypot.php
        • Images.php
        • Kint.php
        • Logger.php
        • Migrations.php
        • Mimes.php
        • Modules.php
        • Pager.php
        • Paths.php
        • Publisher.php
        • Routes.php
        • Security.php
        • Services.php
        • Toolbar.php
        • UserAgents.php
        • Validation.php
        • View.php

Modules Controller

Here is the file structure of controller this files contains all the functions of respective modules.

  • app
    • config
      • Modules
        • AppointmentController.php
        • BlogController.php
        • ChatController.php
        • EcommerceController.php
        • FileManagerController.php
        • MailController.php
        • SofialController.php
      • AuthController.php
      • BaseController.php
      • HomeController.php
      • PermissionRoleController.php
      • UsersController.php

Modules Assets

Here is the file structure of assets folder of respective modules.

  • public
    • assets
      • images
        • landing-pages
          • blog
            • all images regarding this modules
          • home-1
            • all images regarding this modules
          • home-2
            • all images regarding this modules
          • home-3
            • all images regarding this modules
          • home-4
            • all images regarding this modules
          • home-5
            • all images regarding this modules
          • shop
            • all images regarding this modules
      • js
      • modules
        • appointment
          • images
            • all images of this module.
          • js
            • all js of this module
          • scss
            • all scss of this module
        • blog
          • images
            • all images of this module.
          • js
            • all js of this module
          • scss
            • all scss of this module
        • chat
          • images
            • all images of this module.
          • js
            • all js of this module
          • scss
            • all scss of this module
        • e-commerce
          • images
            • all images of this module.
          • js
            • all js of this module
          • scss
            • all scss of this module
        • file-manager
          • images
            • all images of this module.
          • js
            • all js of this module
          • scss
            • all scss of this module
        • mail
          • images
            • all images of this module.
          • js
            • all js of this module
          • scss
            • all scss of this module
        • social-app
          • images
            • all images of this module.
          • js
            • all js of this module
          • scss
            • all scss of this module
      • scss
        • landing-pages
          • components
            • app-landing
              • all css regarding this modules
            • ecommerce-landing
              • all css regarding this modules
            • sass-landing
              • all css regarding this modules
            • shop
              • all css regarding this modules
            • software-landing
              • all css regarding this modules
            • startup-landing
              • all css regarding this modules
      • vendor
    • build

Modules Components

Here is the file structure of components of respective modules.

  • Views
    • app
    • auth
    • components
      • modules
        • appointment
          • partials
            • sidebar, css, js of this modules
          • widgets
            • widgets respective to this modules
        • blog
          • partials and widgets of blog
        • chat
          • partials and widgets of chat
        • e-commerce
          • partials and widgets of e-commerce
        • filemanager
          • partials and widgets of filemanager
        • mail
          • partials and widgets of mail
        • social
          • partials and widgets of social
      • partials
        • all components which repeat continiously in all page. e.g. sidebar, header, footer, etc.
      • widgets
        • Widgets that are used globally in the dashboard. e.g. profile card in dashboard's sidebar.
      • globally used components

Modules Pages

Here is the file structure of blade files of respective modules.

  • Views
    • modules
      • appointment
        • view files of this modules
      • blog
        • view files of this modules
      • chat
        • view files of this modules
      • e-commerce
        • view files of this modules
      • file-manager
        • view files of this modules
      • mail
        • view files of this modules
      • social
        • view files of this modules
    • landing-pages
      • components
        • partials
          • all pages regarding this modules
        • widgets
          • all pages regarding this modules
      • layout
        • all pages regarding this modules
      • pages
        • all pages regarding this modules