Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xtremebiker committed Jul 5, 2014
1 parent ad20429 commit 9c09556
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,20 @@ A simple web servlet which serves reports powered by [BIRT engine](http://www.ec

## How to

- Clone/Download the project. Build it with Maven and the necessary war file with
dependencies will be created.
- Clone/Download the project. Build it with Maven and the necessary war file with dependencies will be created. You can download the deployable file from releases too.

## What does this project offer comparing with the standard BIRT Standalone server?

The BIRT Standalone Server or Runtime is great just for displaying the reports, but it's not usable in production environments. This project implements a RESTful web service layer, that way you can access your reports with a plain HTTP request and you'll get the report itself. It's the ideal way of [having a centralized report server](http://stackoverflow.com/questions/19051144/taking-advantage-of-birt-standalone-runtime).

Forget about including the BIRT runtime (~50MB with dependencies) in each of your deploys, just call the service with the proper parameters!

## First steps

1. The default template path is set to /home/birtserver/templates/. There's a simple
test template included in the project (in WEB-INF), just copy it to that folder.
1. The default template path is set to /home/birtserver/templates/. The server will try to copy the test template to that folder.

2. Navigate to *{deployUrl}* in your browser. You'll see the test report displayed.

## Project details

- This project is open source and everyone is invited to colaborate in it. New
commiters will be welcomed.
- This project is open source and everyone is invited to colaborate in it. New commiters will be welcomed.

0 comments on commit 9c09556

Please sign in to comment.