README.md 4.95 KB
Newer Older
1
# README #
Rolf Guescini's avatar
Rolf Guescini committed
2

3

Andreas Vollmer's avatar
Andreas Vollmer committed
4
## What is this repository for? ###
5
6
7
8
The management and archiving of digital research data is an overlapping field for linguistics, library and information science (LIS) and computer science. These disciplines are cooperating in the LAUDATIO project. The name LAUDATIO is an abbreviation for Long-term Access and Usage of Deeply Annotated Information. The project is funded by the German Research Foundation from 2011-2018. The departments of Corpus Linguistics as well as Historical Linguistics, and the Computer and Media Service (CMS) at Humboldt-Universität zu Berlin and The National Institute for Research in Computer Science and Control (INRIA France) are project partners cooperating with the Berlin School of Library and Information Science (BSLIS).

LAUDATIO aims to build an open access research data repository for historical linguistic data with respect to the above mentioned requirements of historical corpus linguistics. For the access and (re-)use of historical linguistic data the LAUDATIO repository uses a flexible and appropriate documentation schema with a subset of TEI customized by TEI ODD. The extensive metadata schema contains information about the preparation and checking methods applied to the data, tools, formats and annotation guidelines used in the project, as well as bibliographic metadata, and information on the research context (e.g. the research project). To provide complex and comprehensive search in the linguistic annotation data, the linguistic search and visualization tool ANNIS will be integrated in the LAUDATIO repository infrastructure.

Andreas Vollmer's avatar
Andreas Vollmer committed
9
All corpora in LAUDATIO are available under an open access Creative Commons License . All researchers from the academic disciplines of Linguistics and Historical Linguistics can use and re-use the corpora, e.g.:
10
11
12
13
14
15
16

* display corpora,
* search corpora,
* download corpora,
* upload new annotations to an existing corpus
* upload new corpora.

Andreas Vollmer's avatar
Andreas Vollmer committed
17
For further information on how to use the aplication, please head over to the [User Documentation](https://scm.cms.hu-berlin.de/hu-berlin-laudatio-repository/laudatio-repository/-/wikis/LAUDATIO-Repository-User-Manual/Introduction)
18

Andreas Vollmer's avatar
Andreas Vollmer committed
19
20
## Technology stack
LAUDATIO is a three-tiered application consisting of a
21

Andreas Vollmer's avatar
Andreas Vollmer committed
22
1. storage, versioning and search backend, dependent on
Andreas Vollmer's avatar
Andreas Vollmer committed
23
	* [GIT](https://git-scm.com) for storage and versioning
Andreas Vollmer's avatar
Andreas Vollmer committed
24
	* [Python 3](https://www.python.org) scripts implementing a pipeline that processes the [Text Encoding Initiative](https://tei-c.org) XML metadata headers of the Corpora to be indexed in 
Andreas Vollmer's avatar
Andreas Vollmer committed
25
	* [Elasticsearch](https://www.elastic.co/elasticsearch/) (version 7+) for search
Andreas Vollmer's avatar
Andreas Vollmer committed
26
2. application and information flow backend, dependent on
Andreas Vollmer's avatar
Andreas Vollmer committed
27
28
	*  [PHP](https://www.php.net/) as programming language (version 7+)
	*  the [LARAVEL](https://laravel.com/) mvc framework (version 6+) for application models
Andreas Vollmer's avatar
Andreas Vollmer committed
29
	*  the [PostgreSQL database](https://www.postgresql.org) (version 9.6+) for persistence of application data
Andreas Vollmer's avatar
Andreas Vollmer committed
30
	*  the [REDIS in-memory store](https://redis.io) (version 3.2.6+) for caching
Andreas Vollmer's avatar
Andreas Vollmer committed
31
32
3. application frontend, dependent on
	* LARAVEL view templates
Andreas Vollmer's avatar
Andreas Vollmer committed
33
34
35
	* [CSS3](https://www.w3.org/Style/CSS/)  / [SASS](https://sass-lang.com/documentation) / [NPMjs](https://www.npmjs.com/) (version 7+) for compilation of style definitions and javasripts
	* [Vue.js progressive javascript framework](https://vuejs.org/) (version 2.5+) for templating and scripting of frontend views
	* [Bootstrap](https://getbootstrap.com) (version 4+) / [BootstrapVue](https://bootstrap-vue.org/) (version 2+) for layout elements
Andreas Vollmer's avatar
Andreas Vollmer committed
36
 
37

Andreas Vollmer's avatar
Andreas Vollmer committed
38
39
40
41
## How do I get set up? ###

This repository contains the source code of the LAUDATIO repository, if you wish to contribute to the project, please file an issue, and we'll get in touch with you

Andreas Vollmer's avatar
Andreas Vollmer committed
42
To set up your own instance of LAUDATIO, we recommend the [Dockerized version of LAUDATIO](https://scm.cms.hu-berlin.de/hu-berlin-laudatio-repository/laudatio-docker-containers) all piped up and ready to go
Andreas Vollmer's avatar
Andreas Vollmer committed
43
44

## Who do I talk to? ###
45

Andreas Vollmer's avatar
Andreas Vollmer committed
46
* [LAUDATIO collaborators](http://www.laudatio-repository.org/laudatio/mitarbeiter)
Andreas Vollmer's avatar
Andreas Vollmer committed
47
* laudatio-support[at]hu-berlin.de
Andreas Vollmer's avatar
Andreas Vollmer committed
48

Andreas Vollmer's avatar
Andreas Vollmer committed
49
50
51
52
## Licenses

The Laravel framework is licensed under the [MIT license](https://opensource.org/licenses/MIT)

Andreas Vollmer's avatar
Andreas Vollmer committed
53
The Elasticsearch search engine is licensed under [Elastic License 2.0](https://github.com/elastic/elasticsearch/blob/7.14/licenses/ELASTIC-LICENSE-2.0.txt)
Andreas Vollmer's avatar
Andreas Vollmer committed
54

Andreas Vollmer's avatar
Andreas Vollmer committed
55
The Redis in-memory store is licensed under [Three Clause BSD license](https://redis.io/topics/license)
Andreas Vollmer's avatar
Andreas Vollmer committed
56

Andreas Vollmer's avatar
Andreas Vollmer committed
57
The PostgresSQL database is licensed under [PostgreSQL license](https://opensource.org/licenses/postgresql)
Andreas Vollmer's avatar
Andreas Vollmer committed
58

Andreas Vollmer's avatar
Andreas Vollmer committed
59
The PHP programming language is licensed under [PHP License v3.01](https://www.php.net/license/index.php)
Andreas Vollmer's avatar
Andreas Vollmer committed
60
61
62
63

The Vue.js Javascript framework is licensed under the [MIT license](https://opensource.org/licenses/MIT)

The Bootstrap layout/css/javascript framework is licensed under the [MIT license](https://opensource.org/licenses/MIT)
64

Andreas Vollmer's avatar
Andreas Vollmer committed
65

Andreas Vollmer's avatar
Andreas Vollmer committed
66
## Persistent identificator for LAUDTIO@master
Andreas Vollmer's avatar
Andreas Vollmer committed
67
68

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5101366.svg)](https://doi.org/10.5281/zenodo.5101366)