diff --git a/.gitignore b/.gitignore index dc24894..979299d 100644 --- a/.gitignore +++ b/.gitignore @@ -182,4 +182,5 @@ docs/_book test/ /package-lock.json -/yarn.lock \ No newline at end of file +/yarn.lock +/public/env.js \ No newline at end of file diff --git a/README.md b/README.md index ca13970..5eda5c2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # @lfk/selfservice -runner selfservice portal \ No newline at end of file +runner selfservice portal + +## ⚡ Development +### Requirements +- Node.js v14.15.0 or newer +- yarn package manager >= v1.22.10 < 2 + +### Recommended Extensions +- will be automatically recommended via `./vscode/extensions.json` +- we also provide a config for i18n-ally in the `./vscode/` folder + +### Fastest Dev Environment +- You can install the [Remote - Containers](https://github.com/Microsoft/vscode-remote-release) extension and use all recommended extensions and editor settings via the provided `./devcontainer/` config + +## 🔨 environment config +- copy the `/public/env.sample.js` file to `/public/env.js` +- set the required environment variables + - `documentserver_key`: url to the [document server](https://git.odit.services/lfk/document-server) instance + - `baseurl`: url to the main instance + - see [@lfk/deployment](https://git.odit.services/lfk/deployment) for a complete deployment guide \ No newline at end of file diff --git a/index.html b/index.html index 8a98ae3..2e151b8 100644 --- a/index.html +++ b/index.html @@ -10,6 +10,7 @@
+ diff --git a/package.json b/package.json index 0b17e76..db9b0fc 100644 --- a/package.json +++ b/package.json @@ -8,6 +8,7 @@ }, "dependencies": { "got": "^11.8.2", + "marked": "^2.0.1", "redaxios": "^0.4.1", "toastify-js": "^1.9.3", "validator": "^13.5.2", diff --git a/public/env.sample.js b/public/env.sample.js new file mode 100644 index 0000000..1852851 --- /dev/null +++ b/public/env.sample.js @@ -0,0 +1,10 @@ +const config = { + // required + documentserver_key: '', + // required + baseurl: '', + // optional, will fallback to /imprint + url_imprint: '', + // optional, will fallback to /privacy + url_privacy: '' +}; diff --git a/public/imprint_en.md b/public/imprint_en.md new file mode 100644 index 0000000..12e65a1 --- /dev/null +++ b/public/imprint_en.md @@ -0,0 +1 @@ +TODO: \ No newline at end of file diff --git a/public/privacy_en.md b/public/privacy_en.md new file mode 100644 index 0000000..12e65a1 --- /dev/null +++ b/public/privacy_en.md @@ -0,0 +1 @@ +TODO: \ No newline at end of file diff --git a/src/components/EnvError.vue b/src/components/EnvError.vue new file mode 100644 index 0000000..c326305 --- /dev/null +++ b/src/components/EnvError.vue @@ -0,0 +1,29 @@ + +{{ $t('configuration_error') }}
+
+ {{ $t('the_system_is_not_properly_configured_please_contact_the_system_administrator_for_help') }}
+
+
+ {{ $t('if_you_are_the_system_administrator_please_refer_to_the_official_product_documentation_readme_for_configuration_guidance') }}
+