Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thinreports/thinreports-basic-editor
A templte editor for Thinreports to edit Basic Format template.
https://github.com/thinreports/thinreports-basic-editor
electron pdf thinreports
Last synced: 6 days ago
JSON representation
A templte editor for Thinreports to edit Basic Format template.
- Host: GitHub
- URL: https://github.com/thinreports/thinreports-basic-editor
- Owner: thinreports
- License: other
- Created: 2011-07-28T04:04:56.000Z (over 13 years ago)
- Default Branch: main
- Last Pushed: 2023-10-05T18:08:21.000Z (over 1 year ago)
- Last Synced: 2024-10-07T15:02:04.824Z (4 months ago)
- Topics: electron, pdf, thinreports
- Language: JavaScript
- Homepage: https://github.com/thinreports/thinreports
- Size: 65.5 MB
- Stars: 187
- Watchers: 16
- Forks: 45
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Thinreports Basic Editor
[](https://github.com/thinreports/thinreports-basic-editor/actions/workflows/test.yml)
A templte editor for [Thinreports](https://github.com/thinreports/thinreports) to edit [Basic Format](https://github.com/thinreports/thinreports#basic-format) template.
## Renamed to Basic Editor
With [the addition of the new template format Section Format and its editor Section Editor](https://github.com/thinreports/thinreports/issues/12), the editor has been renamed to Thinreports Basic Editor from Thinreports Editor.
See [Two Available Formats](https://github.com/thinreports/thinreports#two-available-formats) for more information.
## Prerequisites
### Supported Platforms
* macOS 10.15+
* Windows 10
* Ubuntu 18.04+
## Installation
Please download the package from [the Releases](https://github.com/thinreports/thinreports-basic-editor/releases) and install it.
## Development
### Requirements
* JDK 6+
* Python 2.7
* Node.js
### Launching the development version app
Install dependencies:
```
npm install
```
Compile javascript, css and templates:
```
npm run compile
```
Launch Editor on development:
```
npm start
```
### Tips
Watch and compile:
```
npm run watch
```
Build package for macOS, Windows, Ubuntu(linux):
```
npm run build
```
Run compilation and building the production version app:
```
npm run release
```
### Compiling using Docker Container
Or if you can use docker, you can compile script and css:
```
docker build -t thinreports-basic-editor:latest .
docker run --rm -v $PWD:/src:cached thinreports-basic-editor:latest
Compiling JavaScript with SIMPLE_OPTIMIZATIONS...
```
And, launch electron on development:
```
npm start
```
## Releasing
This steps are for releasing a new version of Editor.
### 1. Update to the new version
The following two files need to be updated.
- app/editor/version.js
- app/package.json
### 2. Update documents
- CHANGELOG.md (required)
- README.md (if needed)
### 3. Push them to `build/release-x.x.x` branch and test the built packages for each platform
Pushing to `build/*` branch runs a job to build the package. Make sure that the built packages for each platform work properly. You can download the packages from the artifact of the build. For more information.
### 4. Create pull request
If there is no problem, create a pull request.
### 5. Merge pull request and push tag
Pushing a tag runs a job to build and release package. Check the followings:
- Correct version and content of the release
- All package files are attached to the release