Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 1.12 KB

README.md

File metadata and controls

64 lines (45 loc) · 1.12 KB
Raw

docat web

Project setup

yarn install [--pure-lockfile]

Compiles and hot-reloads for development

Configure the backend connection by setting port and host in .env.development.local. Like this configuration for the host 127.0.0.1 and the port 1337.

VUE_APP_BACKEND_PORT=1337
VUE_APP_BACKEND_HOST=127.0.0.1
yarn serve

Compiles and minifies for production

yarn build

Lints and fixes files

yarn lint

Basic Header Theeming

Not happy with the default Docat logo and header? Just add your custom html header to the /var/www/html/config.json file.

{ "headerHTML": "<h1>MyCompany</h1>" }

Customize configuration

See Configuration Reference.

Development

To mount the development dist/ folder while working on the web frontend, you can mount the dist/ folder as a docker volume:

sudo docker run \
  --detach \
  --volume /path/to/doc:/var/docat/doc/ \
  --volume /path/to/locations:/etc/nginx/locations.d/ \
  --volume /path/to/docat/web/dist:/var/www/html/ \
  --publish 8000:80 \
  docat