qor

README

QOR

English Chat Room:

中文聊天室：

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 as of June 2015.

QOR is still beta software - we will probably break an API or two before we 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 will eventually cover features from most of the modules.

What QOR is not

QOR is not a "boxed turnkey solution". You need proper coding skills to use it. It's designed to make the lives of developers easier when building complex EC systems, not providing you one out of the box.

The modules

• Admin - The heart of any QOR system, where you manage all your 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 of translations

• Localization (l10n) - Manage DB-backed models on per-locale basis, with support for defining/editing localizable attributes, and locale-based querying

• Roles - Access Control

API Documentation

We are planning to update the godoc documentation for all modules after the API for the 1.0 release is frozen. Still outstanding are:

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

Example Application

The example application is a work in progress but already covers the following modules:

• Setup & Installation
• Define a first set of resources (qor/admin)
• Introduce Meta - Back Office display control for your resources
• Basic Media library usage
• Using Publish
• L10n & I18n
• [] Roles (very little)
• Worker

Front End Build

Main

Main asset directories of Admin and other modules:

/
├── admin/views/assets/
│   ├── fonts
│   ├── images
│   ├── javascripts
│   └── stylesheets
│
├── i18n/views/themes/i18n/assets/
│   ├── javascripts
│   └── stylesheets
│
├── l10n/views/themes/l10n/assets/
│   ├── javascripts
│   └── stylesheets
│
└── publish/views/themes/publish/assets/
    ├── javascripts
    └── stylesheets

Build

Requires Node.js (with NPM built-in) development environment.

Install Gulp

npm install -g gulp

Install dependencies

npm install

Run Admin tasks

• Watch: gulp
• Build JS: gulp js
• Build CSS: gulp css
• Compile SCSS: gulp sass
• Release: gulp release

Run module tasks

Take I18n module for example:

• Watch: gulp --i18n
• Build JS: gulp js --i18n
• Build CSS: gulp css --i18n
• Compile SCSS: gulp sass --i18n
• Release: gulp release --i18n

Documentation

Index

• type Config
• type Context
  • func (context *Context) GetDB() *gorm.DB
  • func (context *Context) SetDB(db *gorm.DB)
• type CurrentUser

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
	CurrentUser CurrentUser
}

func (*Context) GetDB

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

func (*Context) SetDB

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

type CurrentUser

type CurrentUser interface {
	DisplayName() string
}