Applications

Step 1: Initialize the Admin Panel

First, ensure you have an instance of AdminPanel. If you haven't set this up yet, refer to the Quick Start Guide.

import (
    "log"
    "github.com/go-advanced-admin/admin"
    // Import your ORM and web framework integrations
)

func main() {
    ormIntegrator := /* Initialize your ORM integrator */
    webIntegrator := /* Initialize your web integrator */
    permissionsCheck := /* Define your permission checker function */
    config := /* Define your admin panel configuration */

    adminPanel, err := admin.NewPanel(
        ormIntegrator, webIntegrator, permissionsCheck, &config,
    )
    if err != nil {
        log.Fatalf("Failed to initialize admin panel: %v", err)
    }
}

Step 2: Register an Application

Use the RegisterApp method to create a new application.

appName := "blog"
displayName := "Blog Administration"

app, err := adminPanel.RegisterApp(appName, displayName, nil) // Use `nil` to use the default ORM
if err != nil {
    log.Fatalf("Failed to register app: %v", err)
}

Parameters:

• appName (string): The unique identifier for your application. It should be URL-safe (only letters, numbers, underscores, and hyphens).

• displayName (string): The human-readable name displayed in the admin panel.

• orm (ORMIntegrator): Optional. Use a custom ORM integrator for this app. Pass nil to use the default ORM.

Step 3: Register Models within the Application

After registering the application, you can add models to it. Refer to the Models Guide for detailed instructions.

type Post struct {
    ID      uint   `gorm:"primaryKey"`
    Title   string
    Content string
}

_, err = app.RegisterModel(&Post{}, nil)
if err != nil {
    log.Fatalf("Failed to register model: %v", err)
}

Routing

Each application has its own routing prefix, which is derived from the app name. You can access the app via:

/admin/a/<appName>

For example, if your appName is "blog", the URL would be /admin/a/blog.

Custom ORM Integrator

If you need a different ORM for a specific application, you can provide a custom ORM integrator when registering the app.

customORM := /* Initialize your custom ORM integrator */

app, err := adminPanel.RegisterApp(appName, displayName, customORM)
if err != nil {
    log.Fatalf("Failed to register app with custom ORM: %v", err)
}

Middleware

Currently, middleware is managed at the web framework integration level. To apply middleware to a specific application, you should configure it within your web framework.

Example with Gin:

router := gin.Default()

// Apply middleware to the admin routes
adminGroup := router.Group("/admin", yourMiddleware)
adminPanel.Web.SetRouter(adminGroup)

Custom Template Renderer

If you need custom templates for a specific application, you can set a custom template renderer.

customRenderer := /* Initialize your custom template renderer */

app.SetTemplateRenderer(customRenderer)

Note: Ensure your custom renderer implements the TemplateRenderer interface.

Feedback

We welcome your feedback! If you have suggestions or find issues, please open an issue or submit a pull request.

Thank you for using go-advanced-admin!

note

This section of the documentation was written with the help of Infuzu AI's tools.