File Structure

File & folder structure of software.

Application Codebase

MLM Software is developed on laravel 11, php 8.2 and mysql 8.0.29 version.There has advanced & latest concept used to develop the application to make sure system become up to date and fast to serve. Let's discuss below the structure of application. Mostly structure is cloned of laravel 11 framework but there has a lot of modification and extend the structure as per requirement.

mlm-software
  • app
    • Actions - All the form actions are performed here.
    • Console - Custom commands or closing are defined here.
    • Enums - Status type or others types enums defined here.
    • Events - Events are defined here.
    • Exceptions - Default exceptions handler defined here.
    • Helpers - Custom function or operation defined in helper folder.
    • http
      • Controllers - All application controller by this controllers.
      • Middlewares - All the requests are passing through the middlewares. There has some inbuild or custom middleware defined.
      • Requests - All request validation are written in this folder.
    • Interfaces - Database fields constants are defined here to reduce the errors of table columns.
    • Listeners - When event call there has one or more listener. The operations performed in listener are defined here.
    • Livewire - All tables are handeled by livewire 3. Modules of livewire defined in folder structure.
    • Models - Database Models are defined here. There has Builder subfolder in models where all filter or custom data validation are written.
    • Notification - Whenever any operation performed , notification fired on database or email or sms etc. All notification are handled here.
    • Observers - Whenever any database operation performed observer automatic called. There has only user observer used in this application.
    • Providers - There has default and custom Service Provider defined here to handle the application.
    • Rules - All the validation rules are defined here.
    • Services - All income and third party services are defined here.
    • View - To Show custom data on default views are stored here.
  • bootstrap
    • cached - application bootstrap cache handled here.
    • app.php - Default bootstrap app file.
  • config - There has default config and mlm config file to handle the application easily.
  • database
    • factories - Default laravel factories.
    • migrations - All the database migration are written in this folder.
    • seeders - Default config data or other required data are written in this seeder.
  • lang - Default language handled.
  • public
    • app
      • css - Compiled CSS files
      • img - Image files
      • js - Core Javascript and library wrapper files
      • json - JSON files
      • scss - SASS (SCSS) source files
      • vendor - Third pary libraries (plugins)
    • storage - Storage folder linked to this public/storage folder.
    • vendor - Telescope or third party package assets stored here.
    • .htaccess - Root htaccess file handle complete application request is defined.
    • index.php - Root default index file.
  • resources
    • views - All application view pages are defined here with module wise.
  • routes - Web and api routes are defined here.
  • storage
    • app
      • public - Uploaded files are stored in public folder
      • uploads - Temporary files are uploaded in uploads folder.
    • debugbar - Default debugbar folder.
    • framework
      • cache - Application cache files stored here.
      • sessions - Application sessions files stored here.
      • testing - Application testing files stored here.
      • views - Application views files stored here.
    • logs - Error or exception are automatic build in laravel.log file.
    • media-library - Media library temporary files stored here.
  • tests - Unit or feature testing are defined here.
  • vendor - After composer install command vendor folder automatic created.
  • .env - All the environment variable defined here like application detail or database credentials.
  • .htaccess - It is a file for redirect file for production.
  • .gitattributes - Git attributes file.
  • .gitignore - Git ignore file.
  • artisan - All the artisan commands handler.
  • composer.json - All composer dependencies configure in this file.
  • composer.lock - Auto generated file after composer update.
  • docker-compose.yml - Docker config file used to run laravel application in container with help of Laravel Sail Package.
  • install.sh - Bash script used to install the application smoothly on the server.
  • phpunit.xml - Default unit testing file.