Commit a2aa54b2 authored by Konrad Mohrfeldt's avatar Konrad Mohrfeldt

readme: fix typos and add some clarifications

parent 85ce78f1
Pipeline #1565 failed with stages
in 60 minutes and 7 seconds
......@@ -2,14 +2,14 @@
A Vue.js-based frontend for the Lohrothek REST API.
This project required *NodeJS* and *npm*. If any of the commands below fail, because they are missing refer to the *System Requirements* section below.
This project required *NodeJS* and *npm*. If any of the commands below are missing, refer to the *System Requirements* section at the end of this document.
### Development and Testing Workflow
The project uses a number of external dependencies, that you can install with the `npm install` command. After that you can just run `npm run serve` to start up a development server.
*thekno* ships with fixtures that do not require a backend server, but in case you do want to work with the [Lohrothek REST API](https://git.hack-hro.de/lohro/lohrothek/lohrothek-api) you can do that. The development server started by `npm run serve` will proxy all requests to the `/api/` endpoint to `http://localhost:8000/` by default. This matches the default configuration for the Django webserver. In case you want to use a different backend server or have started Django on a non-standard port you can provide the `PROXY_TARGET` environment variable to `npm run serve`. A development server with the production-environment `Lohrothek REST API` can be started like this:
*thekno* ships with fixtures that do not require a backend server, but in case you do want to work with the [Lohrothek REST API](https://git.hack-hro.de/lohro/lohrothek/lohrothek-api) you can do that. The development server started by `npm run serve` will proxy all requests to the `/api/` endpoint to `http://localhost:8000/` by default. This matches the default configuration for the Django webserver. In case you want to use a different backend server or have started Django on a non-standard port you can provide the `PROXY_TARGET` environment variable to `npm run serve`. A development server with the production-backend available on [thek.lohro.de](https://thek.lohro.de) can be started like this:
```sh
PROXY_TARGET="https://thek.lohro.de/" npm run serve
......@@ -21,7 +21,7 @@ Contributions are always welcome. Before you push your commits or create *merge
## Builds & Deployment
VueJS provides a build target out of the box. You can create a build with `npm run build` and deploy the contents of the `build/dist` directory afterwards. The is also a `Dockerfile` that can be used to create docker images (in fact this `Dockerfile` is used to automatically deploy *thekno* to our [staging server](https://lohro-lohrothek-thekno-staging.lohrothek.git-k8s.hack-hro.de/)).
VueJS provides a build target out of the box. You can create a build with `npm run build` and deploy the contents of the `build/dist` directory afterwards. There is also a `Dockerfile` that can be used to create docker images (in fact this `Dockerfile` is used to automatically deploy *thekno* to our [staging server](https://lohro-lohrothek-thekno-staging.lohrothek.git-k8s.hack-hro.de/)).
There will also be a deb package for Debian at a later point.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment