Frontend for dracor.org

The web app running the dracor.org website.

Development

This project uses Vite as a development and build environment. In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:5173 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Note: The app, by default, expects a local instance of the DraCor API to be available at http://localhost:8080.

You can run the development frontend against a different API instance by setting the environment variable VITE_DRACOR_API to the respective API base URL, e.g.:

VITE_DRACOR_API=https://dracor.org/api/v1 yarn start

yarn test

Launches the test runner in the interactive watch mode.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.

Docker

We provide a Dockerfile that allows to build and run the DraCor Frontend in a Docker container. You can either use a pre-built image from DockerHub or build an image yourself from the sources:

# use the latest pre-build image
docker pull dracor/frontend
# or build the image yourself
docker build -t dracor/frontend .

To start the frontend container and make it available at port 8088 of the local machine run:

docker run -it --rm -p 8088:80 dracor/frontend
# now open http://localhost:8088 in a browser

By default the frontend is connected to the DraCor API at https://dracor.org. To connect the frontend to another API instance specify the environment variable DRACOR_API_HOST like this:

docker run -it --rm -p 8088:80 \
  -e DRACOR_API_HOST=https://staging.dracor.org \
  dracor/frontend

This implies that the base URL for the API is https://staging.dracor.org/api/v1. If the URL path differs from /api/v1, e.g. in a local development environment, it can be overridden with the DRACOR_API_PREFIX variable:

docker run -it --rm -p 8088:80 \
  -e DRACOR_API_HOST=https://192.168.0.10:8080 \
  -e DRACOR_API_PREFIX=/exist/restxq/v1 \
  dracor/frontend

If you want to use local domain names or encounter "502 Bad Gateway" errors you may need to specify a DNS server that can resolve the domain name of your API host:

docker run -it --rm -p 8088:80 \
  -e DRACOR_API_HOST=https://exist:8080 \
  -e DRACOR_API_PREFIX=/exist/restxq/v1 \
  -e NGINX_RESOLVER=192.168.0.1 \
  dracor/frontend

License

dracor-frontend is MIT licensed.