Skip to content

Commit

Permalink
release v0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
FelicitasLoeffler committed Jul 7, 2021
1 parent f8375f1 commit 2cb61b2
Show file tree
Hide file tree
Showing 53 changed files with 2,032 additions and 890 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# [Dai:Si] - A modular framework for Dataset Search

This repository provides the source code for 'Dai:Si' - an application that provides a user interface for querying a dataset search index.
It consists of two parts: a backend server (Node Server) and a frontend (Angular application).
The Node middleware server handles the index requests and provides a convinent API for the frontend - a modular Angular app that can be easily adjusted for a specific domain.
This repository provides the source code for 'Dai:Si' - a frontend framework for querying a dataset search index. The name is an abbrevation of 'Dataset Search' in its phonetic spelling.
Dai:Si consists of two parts: a backend server (Node Server) and a frontend (Angular application).
The Node middleware server handles the index requests and provides a convenient API for the frontend - a modular Angular app that can be easily adjusted for a specific domain.

* [Angular app]
* [Node Server]
Expand All @@ -14,7 +14,7 @@ The Node middleware server handles the index requests and provides a convinent A

A live demo is available here: https://dev.gfbio.uni-jena.de/daisi/

The Node Server and its API is also available: https://dev.gfbio.uni-jena.de/search-api/api-docs/
The Node Server and its API is also available: https://dev.gfbio.uni-jena.de/daisi-api/api-docs/

## How to setup Dataset Search UI for an own index

Expand All @@ -25,6 +25,13 @@ TBD
Please report bugs and issues in the GitHub issue tracker.

## Changelog
07.07.2021 second official release 0.3
* minimap added (select a dataset and if coordinates are present the geographic location is shown on the map)
* dataset basket with download function (select datasets, open the basket and download all files as zip)
* related datasets/publications are displayed
* improved citation dialog (related datasets/publications added)
* bugfix semantic search: expanded terms are only displayed when they occur in the dataset
* config variables for Node and Angular are now provided in separate environment files

26.03.2021 first official release 0.2

Expand Down
22 changes: 17 additions & 5 deletions angular/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
# Dataset Search - Angular (Frontend)
# [Dai:Si] - Angular (Frontend)

The Angular frontend serves as user interface of the <Dataset Search UI> application.
The Angular frontend serves as user interface of <Dai:Si>.

## Installation and Configuration

## CSS adaptions
Install all necessary dependencies: Navigate to the angular folder and run

```npm install```

The src/environment folder contains two files for local settings and adjustments.

`environment.ts` - environment file for development

`environment.prod.ts` - environment file for production

* create a new css file and add it to angular.json under the 'styles.css'. Overwrite all css classes you want to change.

## General Angular instructions

Expand Down Expand Up @@ -35,5 +43,9 @@ Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protrac

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).

## CSS adaptions

* create a new css file and add it to angular.json under the 'styles.css'. Overwrite all css classes you want to change.

## License
<Dataset Search UI> is distributed under the terms of the GNU LGPL v3.0. (https://www.gnu.org/licenses/lgpl-3.0.en.html)
<Dai:Si> is distributed under the terms of the GNU LGPL v3.0. (https://www.gnu.org/licenses/lgpl-3.0.en.html)
28 changes: 18 additions & 10 deletions angular/angular.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"version": 1,
"newProjectRoot": "projects",
"projects": {
"DatasetSearch": {
"DaiSi": {
"projectType": "application",
"schematics": {},
"root": "",
Expand All @@ -13,19 +13,26 @@
"build": {
"builder": "@angular-devkit/build-angular:browser",
"options": {
"outputPath": "dist/DatasetSearch",
"outputPath": "dist/DaiSi",
"index": "src/index.html",
"main": "src/main.ts",
"polyfills": "src/polyfills.ts",
"tsConfig": "tsconfig.app.json",
"aot": true,
"assets": [
"src/favicon.ico",
"src/assets"
"src/assets",
{
"glob": "**/*",
"input": "node_modules/leaflet/dist/images/",
"output": "./assets"
}
],
"styles": [
"./node_modules/@angular/material/prebuilt-themes/indigo-pink.css",
"./node_modules/bootstrap/dist/css/bootstrap.css",
"./node_modules/leaflet/dist/leaflet.css",
"./node_modules/@fortawesome/fontawesome-free/css/all.min.css",
"src/styles.css"
],
"scripts": []
Expand Down Expand Up @@ -64,19 +71,20 @@
"serve": {
"builder": "@angular-devkit/build-angular:dev-server",
"options": {
"browserTarget": "DatasetSearch:build",
"proxyConfig": "src/proxy.conf.json"
"browserTarget": "DaiSi:build",
"proxyConfig": "src/proxy.conf.json",
"port": 4201
},
"configurations": {
"production": {
"browserTarget": "DatasetSearch:build:production"
"browserTarget": "DaiSi:build:production"
}
}
},
"extract-i18n": {
"builder": "@angular-devkit/build-angular:extract-i18n",
"options": {
"browserTarget": "DatasetSearch:build"
"browserTarget": "DaiSi:build"
}
},
"test": {
Expand Down Expand Up @@ -114,18 +122,18 @@
"builder": "@angular-devkit/build-angular:protractor",
"options": {
"protractorConfig": "e2e/protractor.conf.js",
"devServerTarget": "DatasetSearch:serve"
"devServerTarget": "DaiSi:serve"
},
"configurations": {
"production": {
"devServerTarget": "DatasetSearch:serve:production"
"devServerTarget": "DaiSi:serve:production"
}
}
}
}
}
},
"defaultProject": "DatasetSearch",
"defaultProject": "DaiSi",
"cli": {
"analytics": false
}
Expand Down
Loading

0 comments on commit 2cb61b2

Please sign in to comment.