Skip to content
This repository was archived by the owner on Apr 19, 2023. It is now read-only.

Commit 405c499

Browse files
committed
Added README for Aus-e-Lit webapp
1 parent 010954d commit 405c499

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
2+
The Aus-e-Lit Web Application was developed at the UQ ITEE eResearch Lab as part of the
3+
Aus-e-Lit project.
4+
5+
http://itee.uq.edu.au/~eresearch/projects/aus-e-lit/
6+
7+
The webapp provides services for storing annotations and compound objects, combining
8+
several existing web applications (DIAS-B Danno, DIAS-B Emmet and Aus-e-Lit LoreStore)
9+
into one war file for easy deployment and management.
10+
11+
Danno provides an Annotea API and manages annotation storage and querying, Emmet manages authentication and authorisation, and LoreStore provides an API for storing ORE compound objects.
12+
See http://metadata.net/sfprojects/danno.html for more information about Danno and Emmet.
13+
14+
The source code for the webapp is available from https://github.com/auselit/webapp/
15+
16+
Apache Maven is used for dependency management and building the web app. The modules required are
17+
18+
* auselit.danno.site (Maven war overlay with site-specific configuration, see Danno documentation for examples)
19+
* auselit.danno.extensions (included in webapp on GitHub)
20+
* lorestore (from GitHub https://github.com/auselit/lorestore/)
21+
22+
We use eclipse to import the modules into a workspace as Maven projects (using eGit and using m2eclipse).
23+
The modules should all be located within the same directory (e.g. all within the same eclipse workspace) so that the default paths in the pom file for the webapp project will work.
24+
25+
We build the war file via an eclipse Maven run configuration equivalent to the following command:
26+
27+
mvn clean package
28+
29+
The resulting war file will be auselit.danno.site/target/auselit.war
30+
31+
We also run solr alongside the Aus-e-Lit webapp for full text indexing of annotations.
32+
33+
Please contact us if you would like examples of the the site-specific configuration or solr config.

0 commit comments

Comments
 (0)