Presenter is a rich internet application for lecturers intended to be used for presentation of ARSnova data, especially Peer Instruction results. In contrast to ARSnova (arsnova-legacy-js, Sencha Touch) and ARSnova2 (arsnova-js, Dojo) Presenter targets desktop browsers.
- Git
- Java JDK 7 or OpenJDK 7
- Maven 3
- (CouchDB set up for ARSnova, see arsnova-war documentation and setuptool)
Create a clone of the Presenter repository:
$ git clone git://scm.thm.de/arsnova/arsnova-presenter.git presenter
$ cd presenter
New features for the next release are developed on the master branch. Each minor release has its own maintenance branch which is called x.y-stable. Bugs affecting the stable version and the master should be fixed in the maintenance branch which is merged into master afterwards. Doing it the other way around would cause new features from master to be merged into the maintenance branch.
The following commands check out a maintenance branch, commit changes and merge them into master.
$ git checkout x.y-stable
(do your code modifications)
$ git commit -m "Your commit description"
$ git checkout master
$ git merge x.y-stable
For the release of a new version the following steps should be taken in the Git repository:
Remove the maven SNAPSHOT marker from the version number in pom.xml (x.y.z-SNAPSHOT => x.y.z) and commit:
$ git commit -m "Changed version for release: x.y.z"
Create a tag:
$ git tag -a x.y.z -m "Tagging release x.y.z"
Create a maintenance branch, increase the patch level and commit (only major and minor releases):
$ git branch -b x.y-stable
(adjust pom.xml)
$ git commit -m "Changed version for development: x.y.1-SNAPSHOT"
Increase the minor part (y) or patch level (z) of the version number, readd the SNAPSHOT marker in pom.xml and commit the changes:
$ git commit -m "Changed version for development: x.y.z-SNAPSHOT"
Merge x.y-stable into master using "ours" strategy to prevent later merges of the maintenance branch to apply the version change commit to master:
$ git checkout master
$ git merge -s ours x.y-stable -m "Ignore commits concerning version changes for future merges."
Increase the version number in master (only major and minor releases):
(adjust pom.xml)
$ git commit -m "Changed version for development: x.y.0-SNAPSHOT"
If you want to make changes to Presenter, run the following command to set up a development environment with a running Java servlet container and all dependencies:
$ mvn -Parsnova-war clean process-resources && mvn -Denv=dev package jetty:run
Afterwards, the application will be accessible under:
http://localhost:8080/presenter/
Changes to the code base can be tested without restarting the servlet container. Without a correctly set up CouchDB you will still be able to access the application and log in.
- Java JDK 6 or OpenJDK 6 (or later)
- Maven 3
While ARSnova Presenter runs on any platform supported by Java servlet containers it can currently only be built in Unix-like environments (Linux, MacOS X).
If the ARSnova RESTful API (provided by arsnova-war) is not deployed in the ROOT context (/) of the servlet container, you need to make the adjustments to the file src/main/websources/prod.html. Look for the following section:
var dojoConfig = {
arsnova: {
mobileStudentSessionUrl: "/index.html#id/${sessionKey}"
},
arsnovaApi: {
root: "/"
}
};
Prepend the context path of arsnova-war to the URLs set with "mobileStudentSessionUrl" and "root". If you are planning to run Presenter under another (sub)domain you have to make sure that arsnova-war is configured correctly to allow Cross Origin Requests (CORS) form that host. Otherwise browsers will block the requests sent by Presenter.
To create a WAR archive ready for deployment in a Java servlet container run the following command:
$ mvn -Denv=prod clean package
- a Java servlet container already running arsnova-war
- the Presenter application in form of a webarchive (.war file)
Presenter is a front end application running on top of arsnova-war. See installation instructions provided by arsnova-war if it is not installed yet. If you want to adjust the default settings of Presenter and/or do not want to use a provided .war archive, start with the "Build" section.
For information about how to deploy a .war archive with your servlet container please refer to the servlet container's documentation.
GPLv3 or later, see COPYING file