https://github.com/atlasoflivingaustralia/ecodata
Data capture webservices supporting Biocollect and other apps
https://github.com/atlasoflivingaustralia/ecodata
ala-product-biocollect
Last synced: 17 days ago
JSON representation
Data capture webservices supporting Biocollect and other apps
- Host: GitHub
- URL: https://github.com/atlasoflivingaustralia/ecodata
- Owner: AtlasOfLivingAustralia
- Created: 2014-07-07T04:39:04.000Z (almost 11 years ago)
- Default Branch: dev
- Last Pushed: 2025-05-06T05:13:04.000Z (24 days ago)
- Last Synced: 2025-05-06T06:25:35.292Z (24 days ago)
- Topics: ala-product-biocollect
- Language: Groovy
- Homepage: https://ecodata.ala.org.au/documentation/index
- Size: 32.7 MB
- Stars: 8
- Watchers: 10
- Forks: 15
- Open Issues: 92
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Ecodata
### Build Status
[](https://travis-ci.org/AtlasOfLivingAustralia/ecodata)
### About
Ecodata provides primarily data services for the [MERIT](https://github.com/AtlasOfLivingAustralia/fieldcapture) and [BioCollect](https://github.com/AtlasOfLivingAustralia/fieldcapture) applications.
See [MERIT schema](https://github.com/AtlasOfLivingAustralia/ecodata/wiki/MeritSchema) and
[BioCollect schema](https://github.com/AtlasOfLivingAustralia/ecodata/wiki/BioCollectSchema) for an overview of the data.
It implements a JSON/HTTP API to provide access to the data.
### Technologies
* Grails framework 5.2.x
* MongoDB 5+
* Elasticsearch 7.x
* Java 11
### Setup
* Install Elasticsearch into local machine. https://www.elastic.co/guide/en/elasticsearch/reference/7.x/brew.html
* Clone the repository to your development machine.
* Create local directories:
```
/data/ecodata/config
/data/ecodata/uploads
```
* Ecodata expects by default the program, activity and output configuration files to be found at:
```
/data/ecodata/models
```
These models are checked in to git in the $PROJECT_ROOT/models folder. You can either create a soft link to this folder from /data/ecodata/models or change Config.groovy
```
environments {
development {
...
app.external.model.dir = "./models/"
...
```
* The application expects any external configuration file to be located in the path below. An example configuration can be found at: https://github.com/AtlasOfLivingAustralia/ala-install/blob/master/ansible/inventories/vagrant/ecodata-vagrant
```
/data/ecodata/config/ecodata-config.properties
```
This configuration file largely specifies URLs to ecodata dependencies. See https://github.com/AtlasOfLivingAustralia/ecodata/wiki/Ecodata-Dependencies for information about these.
Note that you will need to obtain an ALA API key to use ALA services and a Google Maps API key and specify them in this file.
#### Elasticsearch configuration
Elasticsearch requires an additional configuration item in elasticsearch.yml
```indices.query.bool.max_clause_count: 8192```
### Testing
* To run the grails unit tests, use:
```
grails test-app
```
### Running
ecodata depends on a running instance of CAS and the API Key service so ensure these dependencies are available in your environment and configured correctly in ecodata-config.properties.
```
grails run-app
```
Because of the embedded elasticsearch index and the creation of in-memory spreadsheets for download, ecodata can benefit from a larger heap. If you encounter OutOfMemoryErrors, increase the application heap size with -Xmx4G.