From 7c000e66159382ee561d07a71c8750e4404222e1 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Thu, 2 Feb 2023 08:14:45 +0100 Subject: [PATCH 01/12] docs: added missing README file --- showcase/vue-showcase/README.md | 38 +++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 showcase/vue-showcase/README.md diff --git a/showcase/vue-showcase/README.md b/showcase/vue-showcase/README.md new file mode 100644 index 000000000..a7a571889 --- /dev/null +++ b/showcase/vue-showcase/README.md @@ -0,0 +1,38 @@ +# DB-UI Vue Showcase + +![Apache 2.0 license badge](https://img.shields.io/badge/License-Apache_2.0-blue.svg) +[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) +[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) +[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) + +This project was generated with _tbd_. + +## Development server + +Run `vite` or `npm run dev` for a dev server. The app will automatically reload if you change any of the source files. + +## Build + +Run `npm run build` to build the project. + +## Contributions + +Contributions are very welcome, please refer to the [contribution guide](https://github.com/db-ui/elements/blob/main/CONTRIBUTING.md). + +## Code of conduct + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone – have a look at our [Contributor Covenant Code of Conduct](https://github.com/db-ui/elements/blob/main/CODE-OF-CONDUCT.md). + +## Deutsche Bahn brand + +As we'd like to perfectly support our users and customers on their digital journey, the usage of Deutsche Bahn brand and trademarks are bound of clear guidelines and restrictions even when being used with the code that we're provide with this product. + +Deutsche Bahn fully reserves all rights regarding the Deutsche Bahn brand, even though that we're providing the code of DB UI products free to use and release it under the Apache 2.0 license. +Please have a look at our brand portal at for any further questions and whom to contact on any brand issues. + +You must remove or replace any Deutsche Bahn brand and design assets as well as protected characteristics and trademarks. We're even also planning to provide a neutral theme that would make it much easier for you to use our product without the trademarks by Deutsche Bahn. + +## License + +This project is licensed under [Apache-2.0](LICENSE). From 24b613072d2bee680edd90fb280341123de0f6c9 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Thu, 2 Feb 2023 08:21:37 +0100 Subject: [PATCH 02/12] docs: added Angular showcases GitHub pages URL --- showcase/angular-showcase/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/showcase/angular-showcase/README.md b/showcase/angular-showcase/README.md index ecddf3653..0ab471d8e 100644 --- a/showcase/angular-showcase/README.md +++ b/showcase/angular-showcase/README.md @@ -5,7 +5,7 @@ [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) -This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.0.5. +This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.0.5. We're also [hosting the build on GitHub pages](https://db-ui.github.io/elements/angular-showcase/#/). ## Development server From c858b616aa988d86a039977e8cd6db3585934c03 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Thu, 2 Feb 2023 08:22:44 +0100 Subject: [PATCH 03/12] docs: added React showcases GitHub pages URL --- showcase/react-showcase/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/showcase/react-showcase/README.md b/showcase/react-showcase/README.md index 0cece3cfc..1dfe06f37 100644 --- a/showcase/react-showcase/README.md +++ b/showcase/react-showcase/README.md @@ -5,7 +5,7 @@ [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) -This project is for reference how to use DB UI Elements with vanilla React. +This project is for reference how to use DB UI Elements with vanilla React. We're also [hosting the build on GitHub pages](https://db-ui.github.io/elements/react-showcase/index.html). ## Installation @@ -74,4 +74,4 @@ You must remove or replace any Deutsche Bahn brand and design assets as well as ## License -This project is licensed under [Apache-2.0](LICENSE). \ No newline at end of file +This project is licensed under [Apache-2.0](LICENSE). From aaf43d43a2adfb5c5116be87fca6cc16350722aa Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Thu, 2 Feb 2023 08:24:39 +0100 Subject: [PATCH 04/12] docs: added Vue showcases GitHub Pages URL --- showcase/vue-showcase/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/showcase/vue-showcase/README.md b/showcase/vue-showcase/README.md index a7a571889..6d1c31e0c 100644 --- a/showcase/vue-showcase/README.md +++ b/showcase/vue-showcase/README.md @@ -5,7 +5,7 @@ [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) -This project was generated with _tbd_. +This project was generated with _tbd_. We're also [hosting the build on GitHub pages](hthttps://db-ui.github.io/elements/vue-showcase/index.html#/). ## Development server From 54426a37c52b72523676807505e388fabc2c255d Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Thu, 2 Feb 2023 08:30:56 +0100 Subject: [PATCH 05/12] chore: wording --- doc/howto-javascript.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/howto-javascript.md b/doc/howto-javascript.md index 933fb2a64..50dd39c31 100644 --- a/doc/howto-javascript.md +++ b/doc/howto-javascript.md @@ -90,8 +90,8 @@ In order to test the installation just add a component to your html, like in the ## Frameworks -See documentation for Angular, React and Vue +See documentation for the JavaScript frameworks that we're further supporting: - [Angular](https://github.com/db-ui/elements/blob/main/doc/howto-angular.md) - [React](https://github.com/db-ui/elements/blob/main/doc/howto-react.md) -- [Vue](https://github.com/db-ui/elements/blob/main/doc/howto-vue.md) \ No newline at end of file +- [Vue](https://github.com/db-ui/elements/blob/main/doc/howto-vue.md) From 521be296772297ed4e6c0d9beab26204450e0fc3 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Thu, 2 Feb 2023 08:32:52 +0100 Subject: [PATCH 06/12] docs: corrected those links --- doc/howto-react.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/howto-react.md b/doc/howto-react.md index 2fc69cd3e..4206313be 100644 --- a/doc/howto-react.md +++ b/doc/howto-react.md @@ -65,6 +65,6 @@ Attaching events to DB UI Elements Web Components in React works mostly like you ### Example -[React Showcase GitHub](https://github.com/db-ui/elements/-/tree/develop/showcase/react-showcase) +[React Showcase GitHub](https://github.com/db-ui/elements/tree/main/showcase/react-showcase) -[React Showcase App](https://github.com/db-ui/elements/react-showcase/index.html) +[React Showcase App](https://db-ui.github.io/elements/react-showcase/index.html) From bbfab99c793997c693402193067247c652c56fc8 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Thu, 2 Feb 2023 08:34:09 +0100 Subject: [PATCH 07/12] docs: corrected those links --- doc/howto-vue.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/howto-vue.md b/doc/howto-vue.md index 269db801f..f6509fa6d 100644 --- a/doc/howto-vue.md +++ b/doc/howto-vue.md @@ -95,6 +95,6 @@ Both Inputs in this example do the same: ### Example -[Vue Showcase GitHub](https://github.com/db-ui/elements/-/tree/develop/showcase/vue-showcase) +[Vue Showcase GitHub](https://github.com/db-ui/elements/tree/main/showcase/vue-showcase) -[Vue Showcase App](https://github.com/db-ui/elements/vue-showcase/index.html) +[Vue Showcase App](htthttps://db-ui.github.io/elements/vue-showcase/index.html#/) From b436df75a7d28c6f15de77223266b7f1f750738e Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Thu, 2 Feb 2023 08:35:22 +0100 Subject: [PATCH 08/12] docs: corrected URLs --- doc/howto-angular.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/howto-angular.md b/doc/howto-angular.md index 5618a1f2f..bf4ae2584 100644 --- a/doc/howto-angular.md +++ b/doc/howto-angular.md @@ -127,6 +127,6 @@ There are 3 ways to use Events in Angular: ### Example -[Angular Showcase GitHub](https://github.com/db-ui/elements/-/tree/develop/showcase/angular-showcase) +[Angular Showcase GitHub](https://github.com/db-ui/elements/tree/main/showcase/angular-showcase) -[Angular Showcase App](https://github.com/db-ui/elements/angular-showcase/index.html) +[Angular Showcase App](https://db-ui.github.io/elements/angular-showcase/) From 36f7684a7c2c224f136357560fd1e3516ec65cde Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Thu, 2 Feb 2023 08:36:05 +0100 Subject: [PATCH 09/12] chore: slight optimization --- doc/howto-react.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/howto-react.md b/doc/howto-react.md index 4206313be..282047bc7 100644 --- a/doc/howto-react.md +++ b/doc/howto-react.md @@ -67,4 +67,4 @@ Attaching events to DB UI Elements Web Components in React works mostly like you [React Showcase GitHub](https://github.com/db-ui/elements/tree/main/showcase/react-showcase) -[React Showcase App](https://db-ui.github.io/elements/react-showcase/index.html) +[React Showcase App](https://db-ui.github.io/elements/react-showcase/) From 924ccf0c5a4c94d26d7d6fee2281ae6b270be8a9 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Thu, 2 Feb 2023 08:36:27 +0100 Subject: [PATCH 10/12] chore: slight optimization --- doc/howto-vue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/howto-vue.md b/doc/howto-vue.md index f6509fa6d..d0bc14a4c 100644 --- a/doc/howto-vue.md +++ b/doc/howto-vue.md @@ -97,4 +97,4 @@ Both Inputs in this example do the same: [Vue Showcase GitHub](https://github.com/db-ui/elements/tree/main/showcase/vue-showcase) -[Vue Showcase App](htthttps://db-ui.github.io/elements/vue-showcase/index.html#/) +[Vue Showcase App](htthttps://db-ui.github.io/elements/vue-showcase/) From b5cd49750bb55e7ec444f508e4358b90b3ebab32 Mon Sep 17 00:00:00 2001 From: Maximilian Franzke <787658+mfranzke@users.noreply.github.com> Date: Thu, 2 Feb 2023 08:40:06 +0100 Subject: [PATCH 11/12] fix: corrected that URL --- doc/howto-vue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/howto-vue.md b/doc/howto-vue.md index d0bc14a4c..256af877c 100644 --- a/doc/howto-vue.md +++ b/doc/howto-vue.md @@ -97,4 +97,4 @@ Both Inputs in this example do the same: [Vue Showcase GitHub](https://github.com/db-ui/elements/tree/main/showcase/vue-showcase) -[Vue Showcase App](htthttps://db-ui.github.io/elements/vue-showcase/) +[Vue Showcase App](https://db-ui.github.io/elements/vue-showcase/) From 62137fe46384b767e7561d9783a4e4990620cf56 Mon Sep 17 00:00:00 2001 From: Nicolas Merget <104347736+nmerget@users.noreply.github.com> Date: Tue, 7 Feb 2023 13:31:36 +0100 Subject: [PATCH 12/12] Update README.md --- showcase/vue-showcase/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/showcase/vue-showcase/README.md b/showcase/vue-showcase/README.md index 6d1c31e0c..6d80e5c59 100644 --- a/showcase/vue-showcase/README.md +++ b/showcase/vue-showcase/README.md @@ -5,7 +5,7 @@ [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) -This project was generated with _tbd_. We're also [hosting the build on GitHub pages](hthttps://db-ui.github.io/elements/vue-showcase/index.html#/). +This project was generated with [Vite](https://vitejs.dev/). We're also [hosting the build on GitHub pages](hthttps://db-ui.github.io/elements/vue-showcase/index.html#/). ## Development server