From 99764ffc35169c2fc22cbaaf03f491c32f629c16 Mon Sep 17 00:00:00 2001 From: jacovinus Date: Thu, 11 Jan 2024 15:39:54 +0100 Subject: [PATCH] fix: update README.md --- BUILD.md | 10 +++++----- README.md | 33 ++++++++++++++++++++++++++++++--- 2 files changed, 35 insertions(+), 8 deletions(-) diff --git a/BUILD.md b/BUILD.md index 273832f5..d1ff4c59 100644 --- a/BUILD.md +++ b/BUILD.md @@ -9,13 +9,13 @@ ##### install: ```bash -~/$ npm install +~/$ pnpm install ``` ##### serve (development mode): ```bash -~/$ npm start +~/$ pnpm dev ``` will serve the UI on ``http://localhost:8080`` @@ -24,7 +24,7 @@ will serve the UI on ``http://localhost:8080`` ```bash -~/$ npm run build +~/$ pnpm run build ``` #### *Serve (dist):* @@ -37,7 +37,7 @@ will serve the UI on ``http://localhost:8080`` 2 - Serve ```bash -~/$ serve -s build +~/$ serve -s ./packages/main/dist ``` will serve by default the UI on ``http://localhost:3000`` @@ -54,5 +54,5 @@ will serve by default the UI on ``http://localhost:3000`` - ``API_URL`` default: ``http://localhost:3100`` ```bash -~/$ HOST=localhost PORT=8080 API_URL=http://qryn-host:3100 npm start +~/$ HOST=localhost PORT=8080 API_URL=http://qryn-host:3100 pnpm dev ``` diff --git a/README.md b/README.md index bbd58578..681837af 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ Install Serve (npm serve) ```bash sudo npm i -g serve -serve -s build +serve -s ./packages/main/dist ``` --- @@ -88,16 +88,43 @@ _Use the [public client](https://view.cloki.org) _(no data goes through the serv #### Environment Variables: - ``HOST`` default: `` 0.0.0.0`` + - ``PORT`` default: ``8080`` + - ``API_URL`` default: ``http://localhost:3100`` + ##### Example ```bash -~/$ HOST=localhost PORT=8080 API_URL=http://qryn-host:3100 npm start +~/$ HOST=localhost PORT=8080 API_URL=http://qryn-host:3100 pnpm dev ``` ------------ + +##### Available Routes + +- qryn-view works under a hash router to make it flexible for static deployments and simpler to run over a single route. + +Current available routes: + +`/#/datasources` : Datasources settings + + +`/#/search` : Main search view + + +`/#/users` : users reserved route + + +`/#/plugins` : custom plugins + +------------ + ##### URL Parameters -_cLoki-view can be controlled through URL parameters__ + + +_qryn-view can be controlled globally through URL parameters__ + + | param | description | default | |-------|-------------|---------|