qor

package module
v0.0.0-...-ea25219 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 30, 2015 License: MIT Imports: 7 Imported by: 0

README

QOR

Build Status

What is QOR?

QOR is a set of libraries written in Go that abstracts common features needed for business applications, CMSs, and E-commerce systems.

This is actually the third version of QOR: 1 and 2 were written in ruby and used internally at The Plant. We decided to rewrite QOR in Go and open source it - which has happened in June 2015.

QOR is still beta software - we will probably break an API or two before we will release a stable 1.0 - scheduled for September 2015.

While nearing API freeze our other main focus is building up API documentation for each module and a tutorial that eventually cover features from most of the modules.

What QOR is not

TODO

The modules

  • Admin - The heart of any QOR system, where you manage all you resources

  • Publish - Providing a staging environment for all content changes to be reviewed before being published to the live system

  • Transition - A configurable State Machine: define states, events (eg. pay order), and validation constraints for state transitions

  • Media Library - Asset Management with support for several cloud storage backends and publishing via a CDN

  • Worker (Batch processing) - A process scheduler

  • Exchange - Data exchange with other business applications using CSV or Excel data

  • Internationalization (i18n) - Managing and (inline) editing translations

  • Localization (l10n) - Managing locales in multilingual environments

  • Roles - Access Control

  • Layout

API Documentation

GoDoc

  • Admin
  • Publish
  • Transition
  • Media Library
  • Worker
  • Exchange
  • Internationalization (i18n)
  • Localization (l10n)
  • Roles
  • Layout

Tutorial

The tutorial is currently a work in progress.

  • Setup & Installation
  • Define a first set of resources
  • Introduce Meta - Back Office display control for your resources
  • Using Publish
  • L10n & I18n
  • Roles

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ExitWithMsg

func ExitWithMsg(str string, value ...interface{})

func FilenameWithLineNum

func FilenameWithLineNum() string

Types

type Config

type Config struct {
	DB *gorm.DB
}

type Context

type Context struct {
	Request    *http.Request
	Writer     http.ResponseWriter
	ResourceID string
	Config     *Config
	Roles      []string
	DB         *gorm.DB
}

func (*Context) GetContext

func (context *Context) GetContext() *Context

func (*Context) GetDB

func (context *Context) GetDB() *gorm.DB

func (*Context) New

func (context *Context) New() *Context

func (*Context) SetDB

func (context *Context) SetDB(db *gorm.DB)

type Contextor

type Contextor interface {
	GetContext() *Context
}

type CurrentUser

type CurrentUser interface {
	DisplayName() string
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL