diff --git a/README.md b/README.md index 5eda5c2..773bb9c 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ runner selfservice portal ## ⚡ Development ### Requirements -- Node.js v14.15.0 or newer +- Node.js v14.16.0 or newer - yarn package manager >= v1.22.10 < 2 ### Recommended Extensions @@ -14,9 +14,17 @@ runner selfservice portal ### 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 +### Manual Dev Environment +``` +yarn && yarn dev --open +``` + +## 🔨 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 + - `baseurl`: url to the main lfk instance - WITH TRAILING SLASH + - see [@lfk/deployment](https://git.odit.services/lfk/deployment) for a complete deployment guide + - `baseurl_selfservice`: location of the selfservice instance - WITH TRAILING SLASH + - e.g. path: `/selfservice/` + - e.g. url: `https://example.com/selfservice/` \ No newline at end of file diff --git a/index.html b/index.html index 2e151b8..955cb15 100644 --- a/index.html +++ b/index.html @@ -11,7 +11,7 @@
- +