Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 1.67 KB

README.md

File metadata and controls

67 lines (42 loc) · 1.67 KB

jochre3-search-client

This template should help get you started developing with Vue 3 in Vite.

Recommended IDE Setup

VSCode + Volar (and disable Vetur).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need Volar to make the TypeScript language service aware of .vue types.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Lint with ESLint

npm run lint

To build the docker file

docker build -t registry.gitlab.com/jochre/jochre3-search-client:[YOUR-TAG] .

To run the docker image

docker-compose -f docker-compose/docker-compose.yml up -d

To take it down again:

docker-compose -f docker-compose/docker-compose.yml down

Customizing

You can customize the search engine by creating the following files in the public folder:

  • conf/config.json - this file must override keys in i18n/locales/en.json. See conf/config-sample.json for an example.
    • In particular, you can add a logo to images, and change "en.header.logo" to point at your new logo.
  • privacy.html - you can use privacy-sample.html as an example.

An example of customization can be found in the docker-compose folder.