top
(README.md)
## Introduction

Qor admin provide easy-to-use interface for data management.

## Quick example

Use 35 lines of code to setup & run Qor admin.

    package main

    import (
      "net/http"

      "github.com/jinzhu/gorm"
      _ "github.com/mattn/go-sqlite3"
      "github.com/qor/qor"
      "github.com/qor/qor/admin"
    )

    type User struct {
      gorm.Model
      Name string
    }

    type Product struct {
      gorm.Model
      Name        string
      Description string
    }

    func main() {
      DB, _ := gorm.Open("sqlite3", "demo.db")
      DB.AutoMigrate(&User{}, &Product{})

      Admin := admin.New(&qor.Config{DB: &DB})
      Admin.AddResource(&User{}, &admin.Config{Menu: []string{"User Management"}})
      Admin.AddResource(&Product{}, &admin.Config{Menu: []string{"Product Management"}})

      mux := http.NewServeMux()
      Admin.MountTo("/admin", mux)
      http.ListenAndServe(":9000", mux)
    }

// TODO: add screenshot after QOR admin UI finished
`go run main.go` and visit `localhost:9000/admin` to see the result !

You can view [qor example](https://github.com/qor/qor/tree/master/example) for a more detailed configuration example.

## Features

- CRUD of any resource
- Search and filtering
- Authentication
- Authorization(detail)
- Custom actions
- Customizable view
- Rich editor
- Image crop
- Integrate-able with [Publish](https://github.com/qor/qor/tree/master/publish)
- Integrate-able with [l10n](https://github.com/qor/qor/tree/master/l10n)
- JSON API supported
- Extendable

## Documentation

https://github.com/qor/qor/wiki

Imports 10 package(s)

  1. github.com/jinzhu/now
  2. github.com/qor/qor
  3. github.com/qor/qor/media_library
  4. github.com/qor/qor/responder
  5. github.com/theplant/cldr
  6. github.com/qor/qor/roles
  7. github.com/qor/inflection
  8. github.com/jinzhu/gorm
  9. github.com/qor/qor/utils
  10. github.com/qor/qor/resource

Test imports 3 package(s)

  1. github.com/qor/qor/admin
  2. github.com/qor/qor/test/utils
  3. github.com/mattn/go-sqlite3