Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ backend/static/js/qleverUI.js
.DS_Store
staticfiles
.env
node_modules
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.12
12 changes: 6 additions & 6 deletions docs/install_qleverui.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ You should now be able to connect to QLever UI via <http://localhost:7000>. Cont


# Installing QLever UI without docker
When not using docker there are some additional steps to do. QLever UI is built upon a [Python 3](https://www.python.org/downloads/) / [Django 5](https://www.djangoproject.com/) backend so you will need to have Python 3 installed in order to run QLever UI. It's strongly recommended to use [virtual environments](https://docs.python.org/3/library/venv.html) to manage the project's dependencies when not using the docker build. In order to manage the dependencies, we use pip.
When not using docker there are some additional steps to do. QLever UI is built upon a [Python 3](https://www.python.org/downloads/) / [Django 5](https://www.djangoproject.com/) backend so you will need to have Python 3 installed in order to run QLever UI. It's strongly recommended to use [virtual environments](https://docs.python.org/3/library/venv.html) to manage the project's dependencies when not using the docker build. In order to manage the dependencies, we use uv.

1. If "[pip](https://pypi.org/project/pip/)" is installed on your system / in your virtual environment you can simply use
1. If "[uv](https://docs.astral.sh/uv/)" is installed on your system you can simply use
```shell
pip install -r requirements.txt
uv sync
```
inside the project folder to automatically install all dependencies. Otherwise, you can find the list of dependencies in the `requirements.txt` file to install them manually.

Expand All @@ -77,19 +77,19 @@ When not using docker there are some additional steps to do. QLever UI is built
## Setting up the database manually
1. The QLever UI backend needs a database connection - by default SQLite is used and no further configuration is required. Simply run:
```shell
python manage.py makemigrations --merge && python manage.py migrate
uv manage.py makemigrations --merge && python manage.py migrate
```
inside the project folder in order to do so. You will only need to do this once. If you prefer you can also overwrite the database [settings](https://docs.djangoproject.com/en/5.1/ref/settings/) to use some other database management system in your `.env`.

2. For configuring your QLever UI backend you will need an administrative user for the QLever UI administration panel. You can create an admin account by simply running the following command in your project folder:
```shell
./manage.py createsuperuser
uv manage.py createsuperuser
```
and following the instructions in your terminal.
## Running QLever UI without docker
You can either start a development server by simply running
```shell
./manage.py runserver localhost:7000
uv manage.py runserver localhost:7000
```
or prepare a productive environment as described in the [Django documentation](https://docs.djangoproject.com/en/5.1/).

Expand Down
14 changes: 14 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[project]
name = "qlever-ui"
version = "0.1.0"
description = "Interactive user interface for the SPARQL search engine QLever."
readme = "README.md"
requires-python = ">=3.12"
dependencies = [
"django-environ==0.11.2",
"django-import-export==3.3.7",
"django==5.0.3",
"gunicorn==22.0.0",
"requests==2.32.0",
"whitenoise[brotli]==6.6.0",
]
52 changes: 49 additions & 3 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,52 @@
# This file was autogenerated by uv via the following command:
# uv pip compile --output-file requirements.txt pyproject.toml
asgiref==3.8.1
# via django
brotli==1.1.0
# via whitenoise
certifi==2024.8.30
# via requests
charset-normalizer==3.4.0
# via requests
defusedxml==0.7.1
# via odfpy
diff-match-patch==20241021
# via django-import-export
django==5.0.3
requests==2.32.0
# via
# qlever-ui (pyproject.toml)
# django-import-export
django-environ==0.11.2
# via qlever-ui (pyproject.toml)
django-import-export==3.3.7
# via qlever-ui (pyproject.toml)
et-xmlfile==2.0.0
# via openpyxl
gunicorn==22.0.0
whitenoise[brotli]==6.6.0
django-environ==0.11.2
# via qlever-ui (pyproject.toml)
idna==3.10
# via requests
markuppy==1.14
# via tablib
odfpy==1.4.1
# via tablib
openpyxl==3.1.5
# via tablib
packaging==24.2
# via gunicorn
pyyaml==6.0.2
# via tablib
requests==2.32.0
# via qlever-ui (pyproject.toml)
sqlparse==0.5.1
# via django
tablib==3.5.0
# via django-import-export
urllib3==2.2.3
# via requests
whitenoise==6.6.0
# via qlever-ui (pyproject.toml)
xlrd==2.0.1
# via tablib
xlwt==1.3.0
# via tablib
Loading