From 747c1d2a906ed46325b999ebc0f079265ad81eeb Mon Sep 17 00:00:00 2001 From: Philipp Dormann Date: Wed, 3 Mar 2021 18:20:53 +0100 Subject: [PATCH 1/6] =?UTF-8?q?=E2=9C=A8=20basic=20env.js=20file=20for=20a?= =?UTF-8?q?pi=20baseurl,=20documentserver=5Fkey?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ref #3 --- .gitignore | 3 ++- index.html | 1 + public/env.sample.js | 6 ++++++ src/components/Register.vue | 2 +- 4 files changed, 10 insertions(+), 2 deletions(-) create mode 100644 public/env.sample.js 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/index.html b/index.html index 8a98ae3..2e151b8 100644 --- a/index.html +++ b/index.html @@ -10,6 +10,7 @@
+ diff --git a/public/env.sample.js b/public/env.sample.js new file mode 100644 index 0000000..fc95691 --- /dev/null +++ b/public/env.sample.js @@ -0,0 +1,6 @@ +const config = { + documentserver_key: '', + baseurl: '', + url_imprint: '', + url_privacy: '' +}; diff --git a/src/components/Register.vue b/src/components/Register.vue index 9622b5a..a8a6673 100644 --- a/src/components/Register.vue +++ b/src/components/Register.vue @@ -254,7 +254,7 @@ function login() { } } toast("registration in progress..."); - axios.post('https://dev.lauf-fuer-kaya.de/api/runners/register', postdata) + axios.post(`${config.baseurl}api/runners/register`, postdata) .then((response) => { response = response.data; const token = response.token; -- 2.47.2 From 5a5261d6b0d4adc62c100a29cebd07d25b89028d Mon Sep 17 00:00:00 2001 From: Philipp Dormann Date: Wed, 3 Mar 2021 19:14:26 +0100 Subject: [PATCH 2/6] basic markdown rendering + routing for /imprint and /privacy ref #3 --- package.json | 1 + public/imprint_en.md | 1 + public/privacy_en.md | 1 + src/components/Footer.vue | 14 ++++++++++++-- src/components/Imprint.vue | 38 ++++++++++++++++++++++++++++++++++++++ src/components/Privacy.vue | 38 ++++++++++++++++++++++++++++++++++++++ src/components/simple.css | 1 + src/locales/en.json | 2 ++ src/main.js | 4 ++++ 9 files changed, 98 insertions(+), 2 deletions(-) create mode 100644 public/imprint_en.md create mode 100644 public/privacy_en.md create mode 100644 src/components/Imprint.vue create mode 100644 src/components/Privacy.vue create mode 100644 src/components/simple.css 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/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/Footer.vue b/src/components/Footer.vue index 168f42f..96b88f6 100644 --- a/src/components/Footer.vue +++ b/src/components/Footer.vue @@ -14,16 +14,26 @@ Impressum Datenschutzerklärung + \ No newline at end of file diff --git a/src/components/Imprint.vue b/src/components/Imprint.vue new file mode 100644 index 0000000..8fa9046 --- /dev/null +++ b/src/components/Imprint.vue @@ -0,0 +1,38 @@ + + + \ No newline at end of file diff --git a/src/components/Privacy.vue b/src/components/Privacy.vue new file mode 100644 index 0000000..94394c8 --- /dev/null +++ b/src/components/Privacy.vue @@ -0,0 +1,38 @@ + + + \ No newline at end of file diff --git a/src/components/simple.css b/src/components/simple.css new file mode 100644 index 0000000..671acf9 --- /dev/null +++ b/src/components/simple.css @@ -0,0 +1 @@ +.simplecontent *{margin:0;padding:0}.simplecontent address,.simplecontent area,.simplecontent article,.simplecontent aside,.simplecontent audio,.simplecontent blockquote,.simplecontent datalist,.simplecontent details,.simplecontent dl,.simplecontent fieldset,.simplecontent figure,.simplecontent form,.simplecontent iframe,.simplecontent img,.simplecontent input,.simplecontent meter,.simplecontent nav,.simplecontent ol,.simplecontent optgroup,.simplecontent option,.simplecontent output,.simplecontent p,.simplecontent pre,.simplecontent progress,.simplecontent ruby,.simplecontent section,.simplecontent table,.simplecontent textarea,.simplecontent ul,.simplecontent video{margin-bottom:1rem}.simplecontent button,.simplecontent html,.simplecontent input,.simplecontent select{font-family:var(--nc-font-sans)}.simplecontent body{margin:0 auto;max-width:750px;padding:2rem;border-radius:6px;overflow-x:hidden;word-break:break-word;overflow-wrap:break-word;background:var(--nc-bg-1);color:var(--nc-tx-2);font-size:1.03rem;line-height:1.5}.simplecontent h1,.simplecontent h2,.simplecontent h3,.simplecontent h4,.simplecontent h5,.simplecontent h6{line-height:1;color:var(--nc-tx-1);padding-top:.875rem}.simplecontent h1,.simplecontent h2,.simplecontent h3{color:var(--nc-tx-1);padding-bottom:2px;margin-bottom:8px;border-bottom:1px solid var(--nc-bg-2)}.simplecontent h4,.simplecontent h5,.simplecontent h6{margin-bottom:.3rem}.simplecontent h1{font-size:2.25rem}.simplecontent h2{font-size:1.85rem}.simplecontent h3{font-size:1.55rem}.simplecontent h4{font-size:1.25rem}.simplecontent h5{font-size:1rem}.simplecontent h6{font-size:.875rem}.simplecontent a{color:#3d5af1}.simplecontent a:hover{color:var(--nc-lk-2)}.simplecontent abbr:hover{cursor:help}.simplecontent blockquote{padding:1.5rem;background:#ddd;border-left:5px solid var(--nc-bg-3)}.simplecontent abbr{cursor:help}.simplecontent blockquote :last-child{padding-bottom:0;margin-bottom:0}.simplecontent header{background:#ddd;border-bottom:1px solid var(--nc-bg-3);padding:2rem 1.5rem;margin:-2rem calc(0px - (50vw - 50%)) 2rem;padding-left:calc(50vw - 50%);padding-right:calc(50vw - 50%)}.simplecontent header h1,.simplecontent header h2,.simplecontent header h3{padding-bottom:0;border-bottom:0}.simplecontent header>:first-child{margin-top:0;padding-top:0}.simplecontent header>:last-child{margin-bottom:0}.simplecontent a button,.simplecontent button,.simplecontent input[type=button],.simplecontent input[type=reset],.simplecontent input[type=submit]{font-size:1rem;display:inline-block;padding:6px 12px;text-align:center;text-decoration:none;white-space:nowrap;background:#3d5af1;color:var(--nc-lk-tx);border:0;border-radius:4px;box-sizing:border-box;cursor:pointer;color:var(--nc-lk-tx)}.simplecontent a button[disabled],.simplecontent button[disabled],.simplecontent input[type=button][disabled],.simplecontent input[type=reset][disabled],.simplecontent input[type=submit][disabled]{cursor:default;opacity:.5;cursor:not-allowed}.simplecontent .button:focus,.simplecontent .button:hover,.simplecontent button:focus,.simplecontent button:hover,.simplecontent input[type=button]:focus,.simplecontent input[type=button]:hover,.simplecontent input[type=reset]:focus,.simplecontent input[type=reset]:hover,.simplecontent input[type=submit]:focus,.simplecontent input[type=submit]:hover{background:var(--nc-lk-2)}.simplecontent code,.simplecontent kbd,.simplecontent pre,.simplecontent samp{font-family:var(--nc-font-mono)}.simplecontent code,.simplecontent kbd,.simplecontent pre,.simplecontent samp{background:#ddd;border:1px solid var(--nc-bg-3);border-radius:4px;padding:3px 6px;font-size:.9rem}.simplecontent kbd{border-bottom:3px solid var(--nc-bg-3)}.simplecontent pre{padding:1rem 1.4rem;max-width:100%;overflow:auto}.simplecontent pre code{background:inherit;font-size:inherit;color:inherit;border:0;padding:0;margin:0}.simplecontent code pre{display:inline;background:inherit;font-size:inherit;color:inherit;border:0;padding:0;margin:0}.simplecontent details{padding:.6rem 1rem;background:#ddd;border:1px solid var(--nc-bg-3);border-radius:4px}.simplecontent summary{cursor:pointer;font-weight:700}.simplecontent details[open]{padding-bottom:.75rem}.simplecontent details[open] summary{margin-bottom:6px}.simplecontent details[open]>:last-child{margin-bottom:0}.simplecontent dt{font-weight:700}.simplecontent dd::before{content:"→ "}.simplecontent hr{border:0;border-bottom:1px solid var(--nc-bg-3);margin:1rem auto}.simplecontent fieldset{margin-top:1rem;padding:2rem;border:1px solid var(--nc-bg-3);border-radius:4px}.simplecontent legend{padding:auto .5rem}.simplecontent table{border-collapse:collapse;width:100%}.simplecontent td,.simplecontent th{border:1px solid var(--nc-bg-3);text-align:left;padding:.5rem}.simplecontent th{background:#ddd}.simplecontent tr:nth-child(even){background:#ddd}.simplecontent table caption{font-weight:700;margin-bottom:.5rem}.simplecontent textarea{max-width:100%}.simplecontent ol,.simplecontent ul{padding-left:2rem}.simplecontent li{margin-top:.4rem}.simplecontent ol ol,.simplecontent ol ul,.simplecontent ul ol,.simplecontent ul ul{margin-bottom:0}.simplecontent mark{padding:3px 6px;background:var(--nc-ac-1);color:var(--nc-ac-tx)}.simplecontent input,.simplecontent select,.simplecontent textarea{padding:6px 12px;margin-bottom:.5rem;background:#ddd;color:var(--nc-tx-2);border:1px solid var(--nc-bg-3);border-radius:4px;box-shadow:none;box-sizing:border-box}.simplecontent img{max-width:100%}.simplecontent blockquote{background:#ececec;}.simplecontent ol{list-style-type: decimal;} .simplecontent ul{list-style-type: circle;} \ No newline at end of file diff --git a/src/locales/en.json b/src/locales/en.json index d5b6ac7..70b0021 100644 --- a/src/locales/en.json +++ b/src/locales/en.json @@ -5,6 +5,7 @@ "download_certificate": "Download certificate", "e_mail_adress": "mail address", "go_to_login": "Go To Login", + "imprint": "Imprint", "lap_time": "Lap time", "lap_times": "Lap times", "main_page_text": "Here you can register for the Lauf Für Kaya! or manage your runner profile.", @@ -15,6 +16,7 @@ "please_provide_a_valid_zipcode": "Please provide a valid zipcode...", "please_provide_valid_mail": "Please provide a valid mail address.", "plz": "zipcode", + "privacy_policy": "Privacy Policy", "profile": "Profile", "provide_address": "Provide a postal address?", "register": { diff --git a/src/main.js b/src/main.js index 78f8eb0..59bcfe3 100644 --- a/src/main.js +++ b/src/main.js @@ -22,6 +22,8 @@ const i18n = createI18n({ // --------------- const Home = import('./components/Home.vue'); +const Imprint = import('./components/Imprint.vue'); +const Privacy = import('./components/Privacy.vue'); const Register = import('./components/Register.vue'); const Profile = import('./components/Profile.vue'); // @@ -29,6 +31,8 @@ const router = createRouter({ history: createWebHistory(), routes: [ { path: '/', component: Home }, + { path: '/imprint', component: Imprint }, + { path: '/privacy', component: Privacy }, { path: '/register', component: Register }, { path: '/profile', component: Profile } ] -- 2.47.2 From 20229ab14252e20ffb3ac0e3e8b9d8f7f31819a3 Mon Sep 17 00:00:00 2001 From: Philipp Dormann Date: Thu, 4 Mar 2021 17:09:47 +0100 Subject: [PATCH 3/6] fallback for env config errors ref #3 --- src/components/EnvError.vue | 7 +++++++ src/main.js | 15 +++++++++++---- 2 files changed, 18 insertions(+), 4 deletions(-) create mode 100644 src/components/EnvError.vue diff --git a/src/components/EnvError.vue b/src/components/EnvError.vue new file mode 100644 index 0000000..5e5e93a --- /dev/null +++ b/src/components/EnvError.vue @@ -0,0 +1,7 @@ + + + \ No newline at end of file diff --git a/src/main.js b/src/main.js index 59bcfe3..a733e63 100644 --- a/src/main.js +++ b/src/main.js @@ -21,21 +21,28 @@ const i18n = createI18n({ }); // --------------- +const EnvError = import('./components/EnvError.vue'); const Home = import('./components/Home.vue'); const Imprint = import('./components/Imprint.vue'); const Privacy = import('./components/Privacy.vue'); const Register = import('./components/Register.vue'); const Profile = import('./components/Profile.vue'); // -const router = createRouter({ - history: createWebHistory(), - routes: [ +let routes = []; +if (config.baseurl && config.documentserver_key) { + routes = [ { path: '/', component: Home }, { path: '/imprint', component: Imprint }, { path: '/privacy', component: Privacy }, { path: '/register', component: Register }, { path: '/profile', component: Profile } - ] + ]; +} else { + routes = [ { path: '/*', component: EnvError } ]; +} +const router = createRouter({ + history: createWebHistory(), + routes }); // --------------- createApp(App).use(Toast).use(i18n).use(router).mount('#app'); -- 2.47.2 From c92d5bf5f2ff7642e2a55abe0002ff94f2d64d3e Mon Sep 17 00:00:00 2001 From: Philipp Dormann Date: Thu, 4 Mar 2021 19:56:17 +0100 Subject: [PATCH 4/6] added ui for configuration errors page ref #3 --- src/components/EnvError.vue | 34 ++++++++++++++++++++++++++++------ src/locales/de.json | 5 +++++ src/locales/en.json | 3 +++ src/main.js | 2 +- 4 files changed, 37 insertions(+), 7 deletions(-) diff --git a/src/components/EnvError.vue b/src/components/EnvError.vue index 5e5e93a..c326305 100644 --- a/src/components/EnvError.vue +++ b/src/components/EnvError.vue @@ -1,7 +1,29 @@ - - \ No newline at end of file +
+
+ + + +

{{ $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') }} +

+
+
+ \ No newline at end of file diff --git a/src/locales/de.json b/src/locales/de.json index 7f924ad..f71699c 100644 --- a/src/locales/de.json +++ b/src/locales/de.json @@ -1,10 +1,13 @@ { "already_have_an_account": "Sie haben bereits einen Account?", "apartment_suite_etc": "Addresszeile 2", + "configuration_error": "Konfigurationsfehler", "distance": "Distanz", "download_certificate": "Urkunde herunterladen", "e_mail_adress": "E-Mail Adresse", "go_to_login": "Zum Login", + "if_you_are_the_system_administrator_please_refer_to_the_official_product_documentation_readme_for_configuration_guidance": "Wenn Sie der Systemadministrator sind, finden Sie Konfigurationsanweisungen in der offiziellen Produktdokumentation / README.", + "imprint": "Impressum", "lap_time": "Rundenzeit", "lap_times": "Rundenzeiten", "main_page_text": "Hier können Sie sich für den Lauf Für Kaya! registrieren oder ihr Läuferprofil verwalten.", @@ -15,6 +18,7 @@ "please_provide_a_valid_zipcode": "Bitte geben Sie eine gültige Postleitzahl an...", "please_provide_valid_mail": "Bitte geben Sie eine gültige E-Mail Adresse an", "plz": "PLZ", + "privacy_policy": "Datenschutzerklärung", "profile": "Profil", "provide_address": "Adresse angeben?", "register": { @@ -25,6 +29,7 @@ "save_changes": "Änderungen speichern", "sponsoring": "Sponsoring", "strasse": "Straße", + "the_system_is_not_properly_configured_please_contact_the_system_administrator_for_help": "Das System ist nicht richtig konfiguriert. Bitte wenden Sie sich an den Systemadministrator, um Hilfe zu erhalten.", "this_is_not_a_valid_international_phone_number": "Dies ist keine gültige internationale Telefonnummer", "view_my_data": "Meine Läuferdaten einsehen", "vorname": "Vorname" diff --git a/src/locales/en.json b/src/locales/en.json index 70b0021..7ce8dba 100644 --- a/src/locales/en.json +++ b/src/locales/en.json @@ -1,10 +1,12 @@ { "already_have_an_account": "Already have an account?", "apartment_suite_etc": "Apartment, suite, etc.", + "configuration_error": "Configuration error", "distance": "Distance", "download_certificate": "Download certificate", "e_mail_adress": "mail address", "go_to_login": "Go To Login", + "if_you_are_the_system_administrator_please_refer_to_the_official_product_documentation_readme_for_configuration_guidance": "If you are the system administrator, please refer to the official product documentation/ README for configuration guidance.", "imprint": "Imprint", "lap_time": "Lap time", "lap_times": "Lap times", @@ -27,6 +29,7 @@ "save_changes": "Save changes", "sponsoring": "Sponsoring", "strasse": "Street/ Block", + "the_system_is_not_properly_configured_please_contact_the_system_administrator_for_help": "The system is not properly configured. Please contact the system administrator for help.", "this_is_not_a_valid_international_phone_number": "This is not a valid international phone number", "view_my_data": "View my data", "vorname": "Firstname" diff --git a/src/main.js b/src/main.js index a733e63..993a4aa 100644 --- a/src/main.js +++ b/src/main.js @@ -38,7 +38,7 @@ if (config.baseurl && config.documentserver_key) { { path: '/profile', component: Profile } ]; } else { - routes = [ { path: '/*', component: EnvError } ]; + routes = [ { path: '/', component: EnvError } ]; } const router = createRouter({ history: createWebHistory(), -- 2.47.2 From 987ac4d02cf63af5acdcc60f0ee2ec54534773cb Mon Sep 17 00:00:00 2001 From: Philipp Dormann Date: Fri, 5 Mar 2021 18:47:15 +0100 Subject: [PATCH 5/6] =?UTF-8?q?=F0=9F=90=9E=20bugfix=20for=20non-existant?= =?UTF-8?q?=20env.js?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ref #3 --- src/main.js | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/src/main.js b/src/main.js index 993a4aa..bd77f66 100644 --- a/src/main.js +++ b/src/main.js @@ -28,17 +28,17 @@ const Privacy = import('./components/Privacy.vue'); const Register = import('./components/Register.vue'); const Profile = import('./components/Profile.vue'); // -let routes = []; -if (config.baseurl && config.documentserver_key) { - routes = [ - { path: '/', component: Home }, - { path: '/imprint', component: Imprint }, - { path: '/privacy', component: Privacy }, - { path: '/register', component: Register }, - { path: '/profile', component: Profile } - ]; -} else { - routes = [ { path: '/', component: EnvError } ]; +let routes = [ { path: '/', component: EnvError } ]; +if (typeof config !== 'undefined') { + if (config.baseurl && config.documentserver_key) { + routes = [ + { path: '/', component: Home }, + { path: '/imprint', component: Imprint }, + { path: '/privacy', component: Privacy }, + { path: '/register', component: Register }, + { path: '/profile', component: Profile } + ]; + } } const router = createRouter({ history: createWebHistory(), -- 2.47.2 From 4c78712f83565f21f3cdee2168f9221e2a007951 Mon Sep 17 00:00:00 2001 From: Philipp Dormann Date: Fri, 5 Mar 2021 18:59:21 +0100 Subject: [PATCH 6/6] =?UTF-8?q?=F0=9F=93=83=20updated=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ref #3 --- README.md | 21 ++++++++++++++++++++- public/env.sample.js | 4 ++++ 2 files changed, 24 insertions(+), 1 deletion(-) 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/public/env.sample.js b/public/env.sample.js index fc95691..1852851 100644 --- a/public/env.sample.js +++ b/public/env.sample.js @@ -1,6 +1,10 @@ const config = { + // required documentserver_key: '', + // required baseurl: '', + // optional, will fallback to /imprint url_imprint: '', + // optional, will fallback to /privacy url_privacy: '' }; -- 2.47.2