https://github.com/digital-blueprint/toolbox-app

Website to search DBP Overview search index.
https://github.com/digital-blueprint/toolbox-app

digital-blueprint typesense

Last synced: 8 months ago
JSON representation

Website to search DBP Overview search index.

• Host: GitHub
• URL: https://github.com/digital-blueprint/toolbox-app
• Owner: digital-blueprint
• License: lgpl-2.1
• Created: 2023-03-03T11:27:52.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-23T03:48:01.000Z (over 1 year ago)
• Last Synced: 2024-12-23T04:29:58.600Z (over 1 year ago)
• Topics: digital-blueprint, typesense
• Language: JavaScript
• Homepage:
• Size: 4.55 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# DBP Overview App

[GitHub](https://github.com/digital-blueprint/toolbox) |

[Demo](https://toolbox-demo.tugraz.at/)

[![? Build, Test and Publish](https://github.com/digital-blueprint/toolbox-app/actions/workflows/build-test-publish.yml/badge.svg)](https://github.com/digital-blueprint/toolbox-app/actions/workflows/build-test-publish.yml)

[![? Create and publish Production Docker image](https://github.com/digital-blueprint/toolbox-app/actions/workflows/build-deploy-docker-image.yml/badge.svg)](https://github.com/digital-blueprint/toolbox-app/actions/workflows/build-deploy-docker-image.yml)

This is an experimental app to display search results for a typesense instance updated by GitLab's CI.

See [DBP Overview Feeder](https://gitlab.tugraz.at/vpu-private/dbp-overview/dbp-overview-feeder)

[Search icons created by Freepik - Flaticon](https://www.flaticon.com/free-icons/search)

## Local development

```bash

# get the source

git clone git@github.com/digital-blueprint/toolbox

cd toolbox

git submodule update --init

# install dependencies

npm install

# constantly build dist/bundle.js and run a local web-server on port 8001 

npm run watch

# same as watch, but using the development environment with the development Typesense server 

APP_ENV=development npm run watch

# same as watch, but with babel, terser, etc active -> very slow

npm run watch-full

# run tests

npm test

# build for deployment

npm build

```

Jump to , and you should get the search/result page.

Set up your local Typesense service instance as described in `README.md`

of [DBP Overview Feeder](https://gitlab.tugraz.at/vpu-private/dbp-overview/dbp-overview-feeder)

## Documentation

About search results, see:

- https://typesense.org/docs/guide/

- https://github.com/typesense/typesense-js

- https://github.com/typesense/typesense-instantsearch-adapter

- https://github.com/algolia/instantsearch.js