parent
987ac4d02c
commit
4c78712f83
21
README.md
21
README.md
|
@ -1,3 +1,22 @@
|
||||||
# @lfk/selfservice
|
# @lfk/selfservice
|
||||||
|
|
||||||
runner selfservice portal
|
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
|
|
@ -1,6 +1,10 @@
|
||||||
const config = {
|
const config = {
|
||||||
|
// required
|
||||||
documentserver_key: '',
|
documentserver_key: '',
|
||||||
|
// required
|
||||||
baseurl: '',
|
baseurl: '',
|
||||||
|
// optional, will fallback to /imprint
|
||||||
url_imprint: '',
|
url_imprint: '',
|
||||||
|
// optional, will fallback to /privacy
|
||||||
url_privacy: ''
|
url_privacy: ''
|
||||||
};
|
};
|
||||||
|
|
Loading…
Reference in New Issue