JavaScript CSS HTML Ruby
Latest commit f8a1f17 Jul 24, 2016 @hidakatsuya hidakatsuya committed on GitHub Merge pull request #63 from thinreports/release-0.9.1
Release 0.9.1

README.md

Thinreports Editor Join the chat at https://gitter.im/thinreports/thinreports-editor

Thinreports is an open source report generation tool for Ruby.

  • Thinreports Editor (GUI Designer)
  • Thinreports Generator (Report Generator for Ruby)

Features

Features of Generator is here.

Easy to use

Less special training, possible to create by drag&drop.

Multi-platform

Currently supported platforms are Windows, Mac and Linux.

I18n Support

Currently supported locales are Japanese and English. Please contribute to translate!

Supported Platforms

ChromeApp ver

ChromeApp version of Thinreports is available for Windows, Mac, and Linux computers. Please see System requirements - Chrome Help for more information.

DesktopApp ver

  • Windows XP/7/8/8.1

Getting Started

Contributing

Report bug, post your suggestion

If you find bugs or improvements for the Editor, please report it here.

Translating

See doc/TRANSLATION.md.

Sending a Pull Request

  1. Fork it
  2. Clone your forked repository (Note: How to clone the source of the Editor)
  3. Create your feature branch: git checkout -b my-new-feature
  4. Fix. See Developing about how to develop.
  5. Commit your changes: git commit -am 'Fixed some bugs'
  6. Push to the branch: git push origin my-new-feature
  7. Create new Pull Request

Developing

Requirements

References for developing

Basic Development Flow

  1. Fix your feature
  2. Rebuild script dependency as needed - How to rebuild script dependency
  3. Check operation of your fixes - How to launch development version of the Editor
  4. Build production version of the Editor - How to build production version of the Editor
  5. Check compilation error - How to build production version of the Editor
  6. Check operation of your fixes - How to launch production of the Editor

How to clone the source of the Editor

$ git clone https://github.com/thinreports/thinreports-editor.git
$ cd thinreports-editor/
$ git submodule update --init

How to launch development version of the Editor

See Step5: Launch your App - ChromeApp Reference to learn how to launch ChromeApp. Then, specify thinreports-editor/src to lanuch.

How to rebuild script dependency

If you have edited goog.require() or goog.provide(), you have to run the following command in order to rebuild the dependency. See Finding Your Way around the Closure Library for learning the Closure Library Namespace.

$ cd thinreports-editor
$ rake dev:calcdeps

Thereby, script list in thinreports-editor/src/app.html will be rebuilt.

How to build production version of the Editor

Run the following command:

$ cd thinreports-editor
$ rake package:build

This command executes the following process:

  1. Remove thinreports-editor/package directory if exists
  2. Create thinreports-editor/package directory
  3. Copy src/{app.html,app.js,background.js,manifest.js,locales} to package directory
  4. Create package/assets directory to copy src/assets/{fonts,iconfs} to package/assets directory
  5. Compile src/assets/*.css to create src/assets/style.css
  6. Append compiled script to package/app.js
  7. Rebuild script list in package/app.html

See thinreports-editor/Rakefile for further details.

How to launch production of the Editor

See How to lanuch development version of the Editor, however you need to specify thinreports-editor/package directory as app folder for launching production version of the Editor.

Then, you must be sure that there are no syntax errors and warnings to see the thinreports-editor/dev/tmp/javascript-compile.log.

Note: Currentry the following errors will be logged in the log file, but you can ignore that.

/path/to/thinreports-editor/src/lib/closure-library/closure/goog/fx/dom.js:209: WARNING - Parse error. Non-JSDoc comment has annotations. Did you mean to start it with '/**'?
  /*
^

/path/to/thinreports-editor/src/lib/closure-library/closure/goog/fx/dom.js:216: WARNING - Parse error. Non-JSDoc comment has annotations. Did you mean to start it with '/**'?
  /*
^

0 error(s), 2 warning(s)

Guidelines

  • JavaScript Annotation required. Syntax and Examples of Annotation is here

Development Tasks

You can see the following task list by running rake -T.

rake dev:build_template  # Compile template of the specification sheet to JavaScript
rake dev:calcdeps        # Calculates core JavaScript dependencies
rake dev:check           # Check structure and syntax of scripts by testing compilation
rake package:build       # Build a release package
rake package:cleanup     # Clean up package

License

Thinreports Editor is licensed under the GPLv3. Please see LICENSE for further details.

Copyright

© 2010-2015 Matsukei Co.,Ltd.