shopadmin

shopadmin

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). You can find a copy of the license at https://www.gnu.org/licenses/agpl-3.0.en.html

For commercial use, please use my contact page to obtain a commercial license.

Introduction

Admin interface for github.com/dracory/shopstore. Provides a ready-to-use admin panel for managing products, categories, discounts, and orders.

Modeled after github.com/dracory/cmsstore/admin — same folder-per-controller pattern, same UiConfig/UiBase conventions.

Features

• Product management — create, update, delete, list with AJAX
• Category management — create, update, delete, list with AJAX
• Discount management — create, delete, list with AJAX
• Order management — list orders, view order details
• Media management — upload, reorder, delete product images
• Metadata & tags — per-product metadata and tag editing
• Customer resolution — pluggable via CustomerResolverInterface (no dependency on any specific user/auth package)
• Custom layouts — bring your own layout via FuncLayout
• Bootstrap + Vue CDN — default UI works out of the box

Installation

go get github.com/dracory/shopadmin

Quick Start

package main

import (
    "log/slog"
    "net/http"
    "os"

    "github.com/dracory/shopadmin"
    "github.com/dracory/shopstore"
)

func main() {
    store, err := shopstore.NewStore(shopstore.NewStoreOptions{
        DB:                 yourDB,
        ProductTableName:   "shop_product",
        CategoryTableName:  "shop_category",
        // ... other table names
        AutomigrateEnabled: true,
    })
    if err != nil {
        log.Fatal(err)
    }

    admin, err := shopadmin.New(shopadmin.AdminOptions{
        Store:       store,
        Logger:      slog.New(slog.NewTextHandler(os.Stderr, nil)),
        AdminHomeURL: "/admin",
        ShopAdminURL: "/admin/shop",
    })
    if err != nil {
        log.Fatal(err)
    }

    http.Handle("/admin/shop", admin)
    http.ListenAndServe(":8080", nil)
}

Integration with a Router

shopadmin.AdminInterface exposes Handle(w, r), which is an http.HandlerFunc-compatible method. Wire it into any router that accepts standard http.Handler:

// stdlib
mux.Handle("/admin/shop", http.HandlerFunc(admin.Handle))

// github.com/dracory/rtr
route := rtr.NewRoute().
    SetName("Admin > Shop").
    SetPath("/admin/shop").
    SetHTMLHandler(admin.Handle)

Customer Resolution

Shopadmin does not depend on userstore or any specific auth package. Instead, order controllers resolve customer names/emails via an optional CustomerResolverInterface:

type CustomerResolverInterface interface {
    FindByID(ctx context.Context, customerID string) (name, email string)
    SearchIDs(ctx context.Context, name, email string) ([]string, error)
}

Provide an implementation at construction time:

admin, _ := shopadmin.New(shopadmin.AdminOptions{
    Store:  store,
    Logger: logger,
    CustomerResolver: &myCustomerResolver{userStore: app.GetUserStore()},
})

If CustomerResolver is nil, customer fields stay empty and customer filtering is disabled — no panic, no error.

See docs/proposal.md for the full design rationale.

Custom Layout

By default, shopadmin renders a bare-bones HTML page with Bootstrap and Vue from CDN. To embed the admin inside your own layout (branding, menus, etc.), provide FuncLayout:

admin, _ := shopadmin.New(shopadmin.AdminOptions{
    Store:  store,
    Logger: logger,
    FuncLayout: func(title, body string, opts struct {
        Styles     []string
        StyleURLs  []string
        Scripts    []string
        ScriptURLs []string
    }) string {
        return myLayout(title, body, opts)
    },
})

The anonymous struct matches cmsstore/admin exactly, so you can reuse your existing cmsstore layout function.

Testing

go test ./...

Tests use an in-memory SQLite database via modernc.org/sqlite — no external services required.