Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/thinreports/thinreports

Thinreports is a PDF generation tools for Ruby, with design tool for editing templates.
https://github.com/thinreports/thinreports

pdf ruby thinreports

Last synced: 7 days ago
JSON representation

Thinreports is a PDF generation tools for Ruby, with design tool for editing templates.

Host: GitHub
URL: https://github.com/thinreports/thinreports
Owner: thinreports
Created: 2014-07-18T03:50:38.000Z (over 10 years ago)
Default Branch: main
Last Pushed: 2023-05-09T14:25:26.000Z (over 1 year ago)
Last Synced: 2024-03-26T02:30:24.201Z (9 months ago)
Topics: pdf, ruby, thinreports
Homepage:
Size: 936 KB
Stars: 76
Watchers: 12
Forks: 5
Open Issues: 4
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

Thinreports

A PDF generation tools for Ruby, with design tool for editing templates.

## Thinreports

Thinreports is a PDF generation tool that provides [Thinreports Basic Editor](https://github.com/thinreports/thinreports-basic-editor) and [Thinreports Section Editor](https://github.com/thinreports/thinreports-section-editor), a design tool for editing templates, and [Thinreports Generator](https://github.com/thinreports/thinreports-generator), a Ruby library for generating PDFs.

## Getting Started

Thinreports allows you to create PDF layouts using the Thinreports Editor, and then load the created template files with Thinreports Generator to generate PDFs by dynamically embedding values and changing shapes and layouts.

### Two Available Template Formats

Currently, Thinreports supports two types of template formats. These are called Basic Format and Section Format, respectively.

The basic functionality of both formats is the same, but Section Format is more functional, expressive, and modern. Also, because of the different design philosophy, the tools and APIs used in each format are different.

### Basic Format

Basic Format is a traditional and stable format in which shapes, text, etc. are placed on a fixed size canvas and a PDF is generated.

- [Installation](https://github.com/thinreports/thinreports/blob/main/getting-started/basic-format.md#installation)
- [Quick Start](https://github.com/thinreports/thinreports/blob/main/getting-started/basic-format.md#quick-start)
- [API Reference](https://github.com/thinreports/thinreports-generator/blob/main/README.md#usage)
- [Examples](https://github.com/thinreports/thinreports-examples)
- [Rails Application Example](https://github.com/thinreports/thinreports-rails-example)

### Section Format

*Currently under development*

Section Format is a new template format that allows you to define a layout by dividing it into units called sections, and then freely combine them to generate a PDF.

- [Features](https://github.com/thinreports/thinreports/blob/main/getting-started/section-format.md#features)
- [Installation](https://github.com/thinreports/thinreports/blob/main/getting-started/section-format.md#installation)
- [Quick Start](https://github.com/thinreports/thinreports/blob/main/getting-started/section-format.md#quick-start)
- [Examples](https://github.com/thinreports/thinreports/blob/main/getting-started/section-format.md#examples)

## News

Please see [Announcements at the our GitHub Discussions](https://github.com/orgs/thinreports/discussions/categories/announcement).

## Support

If you have questions about Thinreports, please feel free to ask them in [the our GitHub Discussions](https://github.com/orgs/thinreports/discussions) forum.

## Contributing

Please see [How to contribute to Thinreports](https://github.com/thinreports/thinreports/blob/main/CONTRIBUTING.md).

## Code of Conduct

This project has adopted the [Contributor Covenant](https://github.com/thinreports/thinreports/blob/main/CODE_OF_CONDUCT.md). Unacceptable behavior can be reported to [email protected] which is monitored by the core team.

## Development

[Releasing Thinreports](https://github.com/thinreports/thinreports/blob/main/development/RELEASING.md)