README.md
# QOR
English Chat Room: [](https://gitter.im/qor/qor?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
中文聊天室： [](https://gitter.im/qor/qor/china)
[](https://travis-ci.com/qor/qor)
**For security issues, please send us an email to security@getqor.com and give us time to respond BEFORE posting as an issue or reporting on public forums.**
## 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 a complete rewrite in Go, of the original QOR, which was a proprietary framework written in Ruby on Rails and used internally at [The Plant](https://theplant.jp). QOR 1.0 is the first version to be open sourced and distributed under the MIT license.
### 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.
## Documentation
<https://doc.getqor.com/>
## The modules
* [Admin](https://github.com/qor/admin) - The core part of QOR system, will generate an admin interface and RESTFul API for you to manage your data
* [Publish](https://github.com/qor/publish) - Providing a staging environment for all content changes to be reviewed before being published to the live system
* [Transition](https://github.com/qor/transition) - A configurable State Machine: define states, events (eg. pay order), and validation constraints for state transitions
* [Media Library](https://github.com/qor/media_library) - Asset Management with support for several cloud storage backends and publishing via a CDN
* [Worker](https://github.com/qor/worker) (Batch processing) - A process scheduler
* [Exchange](https://github.com/qor/exchange) - Data exchange with other business applications using CSV or Excel data
* [Internationalization](https://github.com/qor/i18n) (i18n) - Managing and (inline) editing of translations
* [Localization](https://github.com/qor/l10n) (l10n) - Manage DB-backed models on per-locale basis, with support for defining/editing localizable attributes, and locale-based querying
* [Roles](https://github.com/qor/roles) - Access Control
* And more [https://github.com/qor](https://github.com/qor)
## Live DEMO
* Live Demo [http://demo.getqor.com/admin](http://demo.getqor.com/admin)
* Source Code of Live Demo [https://github.com/qor/qor-example](https://github.com/qor/qor-example)
## Frontend Development
Requires [Node.js](https://nodejs.org/) and [Gulp](http://gulpjs.com/) for building frontend files
```bash
npm install && npm install -g gulp
```
- Watch SCSS/JavaScript changes: `gulp`
- Build Release files: `gulp release`
## License
Released under the [MIT License](http://opensource.org/licenses/MIT).