Thinreports Basic Editor
A templte editor for Thinreports to edit Basic Format template.
Renamed to Basic Editor
With the addition of the new template format Section Format and its editor Section Editor, the editor has been renamed to Thinreports Basic Editor from Thinreports Editor.
See 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 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