Open source platform for designing and rendering various reports.
jsreport is a reporting sever which lets developers define reports using javascript templating engines (like jsrender or handlebars). It supports various report output formats like html, pdf, excel and others. It also includes advanced reporting features like user management, REST API, scheduling, designer or sending emails.
For more informations about the platform please visit http://jsreport.net
see http://jsreport.net/downloads
To be able to install and start jsreport on your development machine you need to do following.
You may find installation troubleshooting guide specific for your platform here.
See Gruntfile.js for build automation options.
###Environemnts
jsreport adapts to production and development nodejs environments. Difference is that in production environment you get javascript files combined and minified for fast web application startup opposite to development environment where you get all js files individually what makes debugging easier. Second difference is that in production environment jsreport use prod.config.json as configuration file opposite to dev.config.json in `development.
To change environment use cmd set NODE_ENV=development or use options your IDE provides. If you don't specify node environment jsreport assumes production as default.
###Configurations
jsreport loads dev.config.json or prod.config.json configuration file on start up based on nodejs environment. If configuration file is not found, jsreport creates default configuration file from example.config.json.
See config documentation for details.
###Tests
grunt test - start tests with file system based db (neDb), no mongo needed
grunt test-mongo - start tests with mongo db, mongodb must be running on localhost
grunt test-all - start tests with nedb and then once again with mongo (used with travis CI)
grunt test-integration - start all tests with nedb including integration tests, needs java, fop and phantomjs running
The easiest way how to contribute to jsreport open source community is to implement jsreport extension. Pull requests to this core repository are also welcome.
Check the tutorial for writing custom extensions
##Roadmap The following features are planned for Q2 and Q3.
The current embedded jsreport editor is way too complex for non developers. We would like to create some plugins into CKEditor and improve end user experience when editing simple template. This should work great with pdf reports but for interactive html reports we need to find a different solution.
###Anonymous statistics Collect anonymous usage statistics from jsreport studio. This won't have any value for the jsreport users, but great value for us.
###Client application We would like to provide a consumer web based application. Where user can login and browse reports. The client application should be very responsive and display well on all kind of client devices from small phones to desktops.
###Phantom pdf improvements The most requested features are support for Table of Contents and click-able links. This is currently work in progress in phantomjs, when it is merged we will try to make it working in jsreport as well.
###Template history extension Extension tracking changes in templates and capable to switch back to one of the previous versions.
Missing a feature? Submit a feature request.
Copyright (c) 2014 Jan Blaha <jan.blaha at hotmail.com>
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3.0 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library.
FAQs
javascript based business reporting
The npm package jsreport receives a total of 1,302 weekly downloads. As such, jsreport popularity was classified as popular.
We found that jsreport demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.
