Skip to content

AtlasOfLivingAustralia/atlas-index

Repository files navigation

Atlas search

Work in progress aggregation of services and UI for the Atlas of Living Australia.

  • Using Spring Boot, React, Elasticsearch, PostgresSQL, and RabbitMQ.
  • Suitable for Kubernetes deployment.

Overview

It is a work in progress and subject to change.

Component Replaces Progress
search-service https://github.com/AtlasOfLivingAustralia/bie-index (service) 90%
https://github.com/AtlasOfLivingAustralia/dashboard (service) 100%
https://github.com/AtlasOfLivingAustralia/fieldguide (service) 95%
https://github.com/AtlasOfLivingAustralia/data-quality-filter-service (service) 95%
https://github.com/AtlasOfLivingAustralia/sandbox (service) 60%
search-ui https://github.com/AtlasOfLivingAustralia/ala-bie-hub (UI) 90%
dashboard-ui https://github.com/AtlasOfLivingAustralia/dashboard (UI) 100%
regions-ui https://github.com/AtlasOfLivingAustralia/regions 100%
admin-ui Admin UI 95%
taxon-descriptions New data preparation tool 100%
names-extract New data preparation tool 100%
search-test local development tool 100%
specimens-ui https://github.com/AtlasOfLivingAustralia/specimenbrowser (UI) 100%
static-server local development tool 100%

Components

  • admin-ui - Admin UI for search-service.
  • common-ui - Common UI components used by other UI projects.
  • dashboard-ui - Dashboard with a summary of ALA data.
  • names-extract - Java application that extracts name information from the Lucene names index to supplement the DwCA names index imported into search-service.
  • regions-ui - Pages to inspect and interact with some spatial regions for their species data.
  • search-service - Spring boot REST web services for accessing and administering the search index and other data.
  • search-test - Java application for comparing GET responses of bie-index and search-service.
  • search-ui - Pages to search the search-service index and display species information.
  • specimens-ui - Pages to search and display specimen information for some sources.
  • static-server - Development only file server for serving static files. Production should use a proper file server.
  • taxon-descriptions - Java application for generating taxon descriptions from profiles, wikipedia, species-lists, and other sources.

Local Development

To prepare the search-service and other UI requirements for local development, follow these steps:

  1. Generate supplemental data for search-service (or fetch the ALA internal bucket)
  2. (Optional) Harvest taxon descriptions for search-service and search-ui (or fetch from the ALA internal bucket)
  3. Start search-service after setting up Elasticsearch, PostgreSQL, RabbitMQ and configuring authentication
  4. Serve static files for UI pages using static-server
  5. Start admin-ui and start building the admin index. See the Admin page.

The user UI applications can now be configured and started.

  1. Start admin-ui
  2. Start dashboard-ui
  3. Start regions-ui
  4. Start search-ui
  5. Start specimens-ui

About

Work in progress aggregation of some ALA services and UI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •