backend/src/README.md

The source code of the backend.

This is just a brief list of the structure and functionality for the source tree, the default, mianly unchanged laravel filles will not be covered by this list.

The source files are well documented, fell free to read trough them.

• app
  The laravel application.

  • Actions
    Custom actions used by the application.

  • Attributes
    Custom attributes used by the application.

  • Enums
    Enums to ensure data integrity.

  • Filament
    The definitions for the admi UI.

  • Filament
    The definitions for the admi UI.

  • Helpers
    Some helper functions for convenience.

  • Http/Controllers
    The controllers to handle all web/api requests

    • Http/Controllers
      The controllers to handle all web/api requests

    • Http/Controllers/Api/v1
      The controllers to handle the API requests

  • Http/Middleware
    The custom middleware to handle all web/api requests

    • HardenHeaders.php
      Hides some unnecessary informations from the bots.

    • StripPaginationInfo.php
      Removes web links from API paginated responses.

  • Http/Requests
    Custom request classes to validate input data for all requests.

  • Http/Resources/Api/v1
    Custom resource classes to return only the needed data for the API calls.

  • Http/Livewire
    One lonly custom Livewire component, that was missing from filament.

  • Http/Models
    The models used by the application.

  • Http/Providers
    The service providers for the application.

  • Http/Traits
    Common code used by multiple classes/enums.

  • Http/Validators/SnowflakeValidator.php
    Minimalistic validator for discord snaowflake.

• database
  Database migrations, factories, seeders.

• public/docs
  The documentation for the API, created by Scribe
  The full API documentation is available here.

• routes/api.php
  The routes the API access.

• routes/console.php
  The custom inline commands for the application.

• tests
  Feature tests for the application.