Installation Guide

Installation

This page offers a broad overview. For detailed instructions, refer to the documentation.

1.) Create a project folder, create a virtual python environment and activate it

mkdir sample_project

python3 -m venv venv

source venv/bin/activate

2.) Download the latest NDR Core module and create a django project

pip install django-ndr-core

django-admin startproject yourprojectname

cd yourprojectname/yourprojectname

3.) Initialize NDR Core

Open settings.py and add ndr_core to the INSTALLED_APPS array. This lets you execute the init script:

cd ..

python manage.py init_ndr_core

Enter the asked values and let the routine overwrite your settings and urls file.

4.) Start your server and start configuring

python manage.py runserver

Go to http://localhost:8000/ to view your page, go to http://localhost:8000/ndr_core/ to get to the administration interface. The default user is ndr_core_admin, the default password is ndr_core

Configuration

Go to http://localhost:8000/ndr_core/ to get to the administration interface. The default user is ndr_core_admin, the default password is ndr_core.

You will need to configure the following to have a functional search:

• A search configuration (Where is your data stored and with which API can it be accessed?)
• Some Search Fields (Which fields do you want to search, what type of data is it?)
• Some Result Display (How should data be presented. Which fields?)
• Search Page where you use your configurated search.

If you want, you can do the following:

• Create Static pages with text in multiple languages.
• Create UI Elements (such as slideshows, viewers,...) and display them
• Change Colors, display styles, etc.