Directory Structure

• Introduction
• The Root Directory
  • The App Directory
  • The Bootstrap Directory
  • The Runtime Directory
  • The Config Directory
  • The Database Directory
  • The Public Directory
  • The Resources Directory
  • The Lang Directory
  • The Routes Directory
  • The Storage Directory
  • The Tests Directory
• The App Directory
  • The Console Directory
  • The Events Directory
  • The Exceptions Directory
  • The Http Directory
  • The Jobs Directory
  • The Listeners Directory
  • The Mail Directory
  • The Models Directory
  • The Notifications Directory
  • The Policies Directory
  • The Providers Directory
  • The Rules Directory

Introduction

The default Hypervel application structure follows by Laravel. It can provide you a great starting point for both large and small applications. You're free to organize your application however you like. But some directories such as bootstrap, config, database and runtime should remain due to the core design in Hypervel.

Here's how you directory structure looks like:

├── app
│   ├── Console
│   │   └── Commands
│   ├── Events
│   ├── Exceptions
│   ├── Http
│   │   ├── Controllers
│   │   ├── Middleware
│   │   └── Requests
|   |── Jobs
│   ├── Listeners
│   ├── Models
│   └── Providers
├── bootstrap
├── config
├── database
│   ├── factories
│   ├── migrations
│   └── seeders
├── lang
│   ├── en
│   ├── zh_CN
│   └── zh_TW
|── public
|── resources
├── routes
├── runtime
│   └── container
├── storage
│   ├── app
|   ├── framework
│   └── logs
└── tests
    ├── Feature
    └── Unit

The Root Directory

The App Directory

The app directory contains the core code of your application. We'll explore this directory in more detail soon; however, almost all of the classes in your application will be in this directory.

The Bootstrap Directory

The bootstrap directory contains the app.php file which bootstraps the framework.

The Runtime Directory

This directory stores files generated by Hypervel during runtime. It houses a container directory which contains framework generated files for caching the scanning result.

The Config Directory

The config directory, as the name implies, contains all of your application's configuration files. It's a great idea to read through all of these files and familiarize yourself with all of the options available to you.

Warning

There's additional autoload directory inside config in Hyperf. This folder is removed in Hypervel. All the config files are flattened as Laravel does.

hyperf.php is preserved for the compatibility of root configs in Hyperf. All the configs here will not include any prefixes. And all the configs in config/config.php are moved to config/app.php in Hypervel.

The Database Directory

The database directory contains your database migrations, model factories, and seeds. If you wish, you may also use this directory to hold an SQLite database.

The Public Directory

The public directory houses your static assets such as images, JavaScript, and CSS.

The Resources Directory

The resources directory contains your views as well as your raw, un-compiled assets such as CSS or JavaScript.

The Lang Directory

The lang directory contains the translation files. Within this directory, there may be subdirectories for each language supported by the application. This is the approach Hypervel uses to manage translation strings for built-in features such as validation error messages.

The Routes Directory

The routes directory contains all of the route definitions for your application. By default, three route files are included with Hypervel: web.php, api.php and console.php.

The web.php file contains routes that serves common requests such as views, files in Hypervel.

The api.php file contains routes that are intended to be stateless, so requests entering the application through these routes are intended to be authenticated and will not have access to session state.

Info

Middleware groups are applied to web.php and api.php, but are kept in empty by default. You can configure them manually if in need.

The console.php file is where you may define all of your closure based console commands. Each closure is bound to a command instance allowing a simple approach to interacting with each command's IO methods. Even though this file does not define HTTP routes, it defines console based entry points (routes) into your application. You may also schedule tasks in the console.php file.

The Storage Directory

The storage directory contains your logs, compiled Blade templates, file caches, and other files generated by the framework. This directory is segregated into app, framework, and logs directories. The app directory may be used to store any files generated by your application. The framework directory is used to store caches (and framework generated files in the future). Finally, the logs directory contains your application's log files.

The storage/app/public directory may be used to store user-generated files, such as profile avatars, that should be publicly accessible. You should create a symbolic link at public/storage which points to this directory.

The Tests Directory

The tests directory contains your automated tests. Example PHPUnit unit tests and feature tests are provided out of the box. Each test class should be suffixed with the word Test. You may run your tests using the /vendor/bin/phpunit commands.

Note

Pest package is not supported yet.

The App Directory

The majority of your application is housed in the app directory. By default, this directory is namespaced under App and is autoloaded by Composer using the PSR-4 autoloading standard.

The app directory contains a variety of additional directories such as Console, Http, and Providers. Think of the Console and Http directories as providing an API into the core of your application. The HTTP protocol and CLI are both mechanisms to interact with your application, but do not actually contain application logic. In other words, they are two ways of issuing commands to your application. The Console directory contains all of your Artisan commands, while the Http directory contains your controllers, middleware, and requests.

Note

Many of the classes in the app directory can be generated by Hypervel via commands. To review the available commands, run the php artisan list make command in your terminal.

The Console Directory

The Console directory contains all of the custom Artisan commands for your application. These commands may be generated using the make:command command. This directory also houses your console kernel, which is where your custom Artisan commands are registered and your scheduled tasks are defined.

The Events Directory

The Events directory houses event classes. Events may be used to alert other parts of your application that a given action has occurred, providing a great deal of flexibility and decoupling.

The Exceptions Directory

The Exceptions directory contains your application's exception handler and is also a good place to place any exceptions thrown by your application. If you would like to customize how your exceptions are logged or rendered, you should modify the Handler class in this directory.

The Http Directory

The Http directory contains your controllers, middleware, and form requests. Almost all of the logic to handle requests entering your application will be placed in this directory.

The Jobs Directory

This directory does not exist by default, but will be created for you if you execute the make:job Artisan command. The Jobs directory houses the queueable jobs for your application. Jobs may be queued by your application or run synchronously within the current request lifecycle. Jobs that run synchronously during the current request are sometimes referred to as "commands" since they are an implementation of the command pattern.

The Listeners Directory

The Listeners directory contains the classes that handle your events. Event listeners receive an event instance and perform logic in response to the event being fired. For example, a UserRegistered event might be handled by a SendWelcomeEmail listener. If you execute the make:listener command, listener classes will be placed in this directory.

The Mail Directory

This directory does not exist by default, but will be created for you if you execute the make:mail Artisan command. The Mail directory contains all of your classes that represent emails sent by your application. Mail objects allow you to encapsulate all of the logic of building an email in a single, simple class that may be sent using the Mail::send method.

The Models Directory

The Models directory contains all of your Eloquent model classes. The Eloquent ORM included with Hypervel provides a beautiful, simple ActiveRecord implementation for working with your database. Each database table has a corresponding "Model" which is used to interact with that table. Models allow you to query for data in your tables, as well as insert new records into the table.

The Notifications Directory

This directory does not exist by default, but will be created for you if you execute the make:notification Artisan command. The Notifications directory contains all of the "transactional" notifications that are sent by your application, such as simple notifications about events that happen within your application. Laravel's notification feature abstracts sending notifications over a variety of drivers such as email, Slack, SMS, or stored in a database.

The Policies Directory

This directory does not exist by default, but will be created for you if you execute the make:policy Artisan command. The Policies directory contains the authorization policy classes for your application. Policies are used to determine if a user can perform a given action against a resource.

The Providers Directory

The Providers directory contains all of the service providers for your application. Service providers bootstrap your application by binding services in the service container, registering events, or performing any other tasks to prepare your application for incoming requests.

In a fresh Hypervel application, this directory will already contain several providers. You are free to add your own providers to this directory as needed.

The Rules Directory

This directory does not exist by default, but will be created for you if you execute the make:rule Artisan command. The Rules directory contains the custom validation rule objects for your application. Rules are used to encapsulate complicated validation logic in a simple object. For more information, check out the validation documentation.