Skip to content

README.md

Latest commit

 

History

History
51 lines (32 loc) · 1.56 KB

README.md

File metadata and controls

51 lines (32 loc) · 1.56 KB
Raw

Go Advanced Admin - Gin Integration

Gin framework integration for the Go Advanced Admin Panel.

This package provides integration with the Gin web framework for the Go Advanced Admin Panel, enabling you to use Gin as your web framework.

Installation

Add the module to your project by running:

go get github.com/ovnicraft/go-advanced-admin-gin

Documentation

For detailed documentation on how to use the Gin integration, please visit the official documentation website.

Note: Gin Quickstart Gin documentation PR is opened.

Quick Start

package main

import (
    admin "github.com/ovnicraft/go-advanced-admin"
    admingin "github.com/ovnicraft/go-advanced-admin-gin"
    "github.com/gin-gonic/gin"
)

func main() {
    r := gin.New()
    web := admingin.NewIntegrator(r.Group("/admin"))

    // Initialize the admin panel with your ORM and permissions
    panel := admin.NewPanel(/* orm */ nil, web, /* perms */ nil, admin.DefaultConfig)

    _ = panel // configure apps/models and start your server
}

For more detailed examples and configuration options, please refer to the Gin Integration Guide.

Contributing

Contributions are always welcome! Please refer to the Contributing Guidelines in the main repository.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.