Directory Structure

• Introduction
• Folder Tree
• Customize Directory Structure

Introduction

The default file structure can make you better start project advancement, and you can also add new folders freely, but do not modify the default folders.

Folder Tree

goravel/
├── app/                        # Core application logic
│   ├── ai/                     # AI agents and tools
│   │   ├── agents/             # AI agent classes
│   │   └── tools/              # AI tool classes
│   ├── console/                # Artisan console commands
│   ├── grpc/                   # gRPC controllers and middleware
│   ├── http/                   # HTTP controllers and middleware
│   │   ├── controllers/        # HTTP request handlers
│   │   ├── middleware/         # HTTP middleware (auth, cors, etc.)
│   ├── models/                 # ORM models
│   └── providers/              # Service providers
├── bootstrap/                  # Application bootstrapping
│   └── app.go                  # Framework initialization
├── config/                     # Application configuration files
├── database/                   # Database related files
│   ├── migrations/             # Database migration files
│   ├── seeders/                # Database seeders
├── resources/                  # Raw, uncompiled assets
│   └── views/                  # View templates
├── routes/                     # Application route definitions
├── storage/                    # Application storage
├── tests/                      # Automated tests
├── .air.toml                   # Air hot reload configuration
├── .env.example                # Environment variables template
├── artisan                     # Artisan console entry script
├── go.mod                      # Go module dependencies
├── go.sum                      # Go module checksums
├── main.go                     # Application entry point

Customize Directory Structure

You can customize the directory structure by calling the WithPaths() function in the bootstrap/app.go file. For example, if you want to change the default app directory to src, you can modify the bootstrap/app.go file as follows:

func Boot() contractsfoundation.Application {
	return foundation.Setup().
		WithPaths(func(paths configuration.Paths) {
			paths.App("src")
		}).
		WithConfig(config.Boot).
		Create()
}

There are many other paths you can customize, such as Config, Database, Routes, Storage, and Resources. AI generator paths can also be customized with Agents and Tools:

func Boot() contractsfoundation.Application {
    return foundation.Setup().
        WithPaths(func(paths configuration.Paths) {
            paths.Agents("internal/ai/agents")
            paths.Tools("internal/ai/tools")
        }).
        WithConfig(config.Boot).
        Create()
}