From b49f16d143494075c03115756d85fdccc8b8e84f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20M=C3=A4hr?= Date: Sat, 9 Mar 2024 22:53:26 +0100 Subject: [PATCH 01/10] feat: readme enhanced --- README.md | 31 +++- assets/images/pagespeed-insights.svg | 231 +++++++++++++++++++++++++++ 2 files changed, 259 insertions(+), 3 deletions(-) create mode 100644 assets/images/pagespeed-insights.svg diff --git a/README.md b/README.md index a6b930ad..13e8dfce 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,30 @@ The open source code of the digital portal of Stadt.Geschichte.Basel. [![GitHub stars](https://img.shields.io/github/stars/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch.svg)](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/stargazers) [![GitHub license](https://img.shields.io/github/license/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch.svg)](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/blob/main/LICENSE.md) +![Lighthouse Accessibility Badge](./assets/images/scores/lighthouse_accessibility.svg) +![Lighthouse Best Practices Badge](./assets/images/scores/lighthouse_best-practices.svg) +![Lighthouse Performance Badge](./assets/images/scores/lighthouse_performance.svg) +![Lighthouse PWA Badge](./assets/images/scores/lighthouse_pwa.svg) +![Lighthouse SEO Badge](./assets/images/scores/lighthouse_seo.svg) + +## Overview + +Welcome to [Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch/), a comprehensive digital and print project aimed at presenting the multifaceted history of Basel from its earliest beginnings to the present. Visit [Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch) to see how our digital portal is bringing Basel's history to life. This live site showcases the practical application of our open-source code, offering an interactive experience of Basel's rich heritage. + +[Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch/) seeks to bridge research gaps and present historical findings in accessible formats. Our project encompasses an extensive nine-volume book series, an overview volume, a digital portal, and a digital platform for research data. These resources are aimed at scholars and the public, making historical research and insights more accessible than ever. + +This project is the open source code of the digital portal of Stadt.Geschichte.Basel. It is a static website built with [SvelteKit](https://kit.svelte.dev/). The website is hosted on [Cloudflare Pages](https://pages.cloudflare.com/). It uses [Hypothese.org](https://sgb.hypotheses.org/) as CMS and consumes data from [Agendabasel](https://agendabasel.ch/) for the agenda. + +The digital platform for research data can be found at [forschung.stadtgeschichtebasel.ch](https://forschung.stadtgeschichtebasel.ch/). The source code for the digital platform can be found [here](https://github.com/Stadt-Geschichte-Basel/forschung.stadtgeschichtebasel.ch). + +## Key Features + +- **Fast Static Website**: The website is built with SvelteKit, providing a fast and responsive user experience. +- **Interactive Features**: The website includes an interactive map, and agenda. +- **Accessibility-Focused Design**: Compliant with WCAG standards, ensuring inclusivity for all users. More at our [accessibility statement](https://stadtgeschichtebasel.ch/barrierefreiheit/). + +![Lighthouse Score](/assets/images/pagespeed-insights.svg) + ## Installation Use the package manager [pnpm](https://pnpm.io/installation) to install all dependencies. @@ -15,7 +39,7 @@ Use the package manager [pnpm](https://pnpm.io/installation) to install all depe pnpm install ``` -Run the prebuild script to generate the static files. +Run the prebuild script to download the pages, posts, and assets from [Hyphotheses.org](https://sgb.hypotheses.org/). ```bash pnpm run prebuild @@ -29,13 +53,13 @@ Run the development server. pnpm run dev ``` -To build for production. +Build for production. ```bash pnpm run build ``` -To optimize the build for production. +Optimize the build with [Jampack](https://jampack.divriots.com/) for production. ```bash pnpm run postbuild @@ -73,6 +97,7 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available, - **Moritz Mähr** - [maehr](https://github.com/maehr) - **Nico Görlich** - [koilebeit](https://github.com/koilebeit) +- **Moritz Twente** - [mtwente](https://github.com/mtwente) See also the list of [contributors](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/graphs/contributors) who participated in this project. diff --git a/assets/images/pagespeed-insights.svg b/assets/images/pagespeed-insights.svg new file mode 100644 index 00000000..86b3c9d4 --- /dev/null +++ b/assets/images/pagespeed-insights.svg @@ -0,0 +1,231 @@ + + + + + + + 99 + Performance + + + + + 100 + Accessibility + + + + + 100 + Best Practices + + + + + 100 + SEO + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Progressive + Web App + + + + + + + + + + + + + + + 0-49 + 50-89 + 90-100 + + + \ No newline at end of file From cc265b4bdc792a1162b579bc70436f131ff0f150 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20M=C3=A4hr?= Date: Sat, 9 Mar 2024 22:56:11 +0100 Subject: [PATCH 02/10] fix: lighthouse badges removed --- README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.md b/README.md index 13e8dfce..7e7738a6 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,6 @@ The open source code of the digital portal of Stadt.Geschichte.Basel. [![GitHub stars](https://img.shields.io/github/stars/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch.svg)](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/stargazers) [![GitHub license](https://img.shields.io/github/license/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch.svg)](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/blob/main/LICENSE.md) -![Lighthouse Accessibility Badge](./assets/images/scores/lighthouse_accessibility.svg) -![Lighthouse Best Practices Badge](./assets/images/scores/lighthouse_best-practices.svg) -![Lighthouse Performance Badge](./assets/images/scores/lighthouse_performance.svg) -![Lighthouse PWA Badge](./assets/images/scores/lighthouse_pwa.svg) -![Lighthouse SEO Badge](./assets/images/scores/lighthouse_seo.svg) - ## Overview Welcome to [Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch/), a comprehensive digital and print project aimed at presenting the multifaceted history of Basel from its earliest beginnings to the present. Visit [Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch) to see how our digital portal is bringing Basel's history to life. This live site showcases the practical application of our open-source code, offering an interactive experience of Basel's rich heritage. From 24760237aa2857fdbd3b96277b22a007d6b11ebd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20M=C3=A4hr?= Date: Sun, 10 Mar 2024 00:55:35 +0100 Subject: [PATCH 03/10] fix: Update README.md Co-authored-by: Moritz Twente <127845092+mtwente@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7e7738a6..e8e87695 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Welcome to [Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch/), a compreh [Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch/) seeks to bridge research gaps and present historical findings in accessible formats. Our project encompasses an extensive nine-volume book series, an overview volume, a digital portal, and a digital platform for research data. These resources are aimed at scholars and the public, making historical research and insights more accessible than ever. -This project is the open source code of the digital portal of Stadt.Geschichte.Basel. It is a static website built with [SvelteKit](https://kit.svelte.dev/). The website is hosted on [Cloudflare Pages](https://pages.cloudflare.com/). It uses [Hypothese.org](https://sgb.hypotheses.org/) as CMS and consumes data from [Agendabasel](https://agendabasel.ch/) for the agenda. +This project is the open source code of the digital portal of Stadt.Geschichte.Basel. It is a static website built with [SvelteKit](https://kit.svelte.dev/). The website is hosted on [Cloudflare Pages](https://pages.cloudflare.com/). It uses [hypotheses.org](https://sgb.hypotheses.org/) as CMS and consumes data from [Agendabasel](https://agendabasel.ch/) for the agenda. The digital platform for research data can be found at [forschung.stadtgeschichtebasel.ch](https://forschung.stadtgeschichtebasel.ch/). The source code for the digital platform can be found [here](https://github.com/Stadt-Geschichte-Basel/forschung.stadtgeschichtebasel.ch). From da6c52b579abf641d33ff8c14ed3df3919ecf4c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20M=C3=A4hr?= Date: Sun, 10 Mar 2024 00:55:45 +0100 Subject: [PATCH 04/10] fix: Update README.md Co-authored-by: Moritz Twente <127845092+mtwente@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e8e87695..05022e4f 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ The digital platform for research data can be found at [forschung.stadtgeschicht - **Fast Static Website**: The website is built with SvelteKit, providing a fast and responsive user experience. - **Interactive Features**: The website includes an interactive map, and agenda. -- **Accessibility-Focused Design**: Compliant with WCAG standards, ensuring inclusivity for all users. More at our [accessibility statement](https://stadtgeschichtebasel.ch/barrierefreiheit/). +- **Accessibility-Focused Design**: Ensuring inclusivity for all users, by complying with WCAG standards and observing neurodiversity design guidelines. More at our [accessibility statement](https://stadtgeschichtebasel.ch/barrierefreiheit/). ![Lighthouse Score](/assets/images/pagespeed-insights.svg) From c8ed63eda247cee9a9a7c480a16df7f6b6c0b080 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20M=C3=A4hr?= Date: Sun, 10 Mar 2024 00:55:54 +0100 Subject: [PATCH 05/10] fix: Update README.md Co-authored-by: Moritz Twente <127845092+mtwente@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 05022e4f..c9b16f35 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Use the package manager [pnpm](https://pnpm.io/installation) to install all depe pnpm install ``` -Run the prebuild script to download the pages, posts, and assets from [Hyphotheses.org](https://sgb.hypotheses.org/). +Run the prebuild script to download the pages, posts, and assets from [hypotheses.org](https://sgb.hypotheses.org/). ```bash pnpm run prebuild From eb18511e08603b16f7037022c2cee26cc62857fc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20M=C3=A4hr?= Date: Sun, 10 Mar 2024 00:56:12 +0100 Subject: [PATCH 06/10] fix: Update README.md Co-authored-by: Moritz Twente <127845092+mtwente@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c9b16f35..ce9223ad 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ The open source code of the digital portal of Stadt.Geschichte.Basel. Welcome to [Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch/), a comprehensive digital and print project aimed at presenting the multifaceted history of Basel from its earliest beginnings to the present. Visit [Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch) to see how our digital portal is bringing Basel's history to life. This live site showcases the practical application of our open-source code, offering an interactive experience of Basel's rich heritage. -[Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch/) seeks to bridge research gaps and present historical findings in accessible formats. Our project encompasses an extensive nine-volume book series, an overview volume, a digital portal, and a digital platform for research data. These resources are aimed at scholars and the public, making historical research and insights more accessible than ever. +[Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch/) seeks to bridge research gaps and present historical findings in accessible formats. Our project encompasses an [extensive nine-volume book series](https://www.merianverlag.ch/buecher/stadt.geschichte.basel.html), an overview volume, a digital portal, and a digital platform for research data. These resources are aimed at scholars and the public, making historical research and insights more accessible than ever. This project is the open source code of the digital portal of Stadt.Geschichte.Basel. It is a static website built with [SvelteKit](https://kit.svelte.dev/). The website is hosted on [Cloudflare Pages](https://pages.cloudflare.com/). It uses [hypotheses.org](https://sgb.hypotheses.org/) as CMS and consumes data from [Agendabasel](https://agendabasel.ch/) for the agenda. From 4d60133fde3329429808ea556f9920a4c1a4155d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20M=C3=A4hr?= Date: Fri, 19 Apr 2024 16:41:51 +0200 Subject: [PATCH 07/10] fix: fix @mtwente commentaries --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ce9223ad..5f737fa6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # stadtgeschichtebasel.ch -The open source code of the digital portal of Stadt.Geschichte.Basel. +The open-source code of the digital portal of Stadt.Geschichte.Basel. [![GitHub issues](https://img.shields.io/github/issues/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch.svg)](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/issues) [![GitHub forks](https://img.shields.io/github/forks/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch.svg)](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/network) @@ -9,19 +9,19 @@ The open source code of the digital portal of Stadt.Geschichte.Basel. ## Overview -Welcome to [Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch/), a comprehensive digital and print project aimed at presenting the multifaceted history of Basel from its earliest beginnings to the present. Visit [Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch) to see how our digital portal is bringing Basel's history to life. This live site showcases the practical application of our open-source code, offering an interactive experience of Basel's rich heritage. +Welcome to [Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch/), a historical research project at the University of Basel in Switzerland, funded with over 9 million Swiss Francs from public and private sources, running from 2017 to 2025. It is a comprehensive digital and print project that aims to present the multifaceted history of Basel from its earliest beginnings to the present day. Visit [Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch) to see how our digital portal brings Basel's history to life. This live site showcases the practical application of our open-source code, offering an interactive experience of Basel's rich heritage. -[Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch/) seeks to bridge research gaps and present historical findings in accessible formats. Our project encompasses an [extensive nine-volume book series](https://www.merianverlag.ch/buecher/stadt.geschichte.basel.html), an overview volume, a digital portal, and a digital platform for research data. These resources are aimed at scholars and the public, making historical research and insights more accessible than ever. +[Stadt.Geschichte.Basel](https://stadtgeschichtebasel.ch/) seeks to bridge research gaps and present historical findings in accessible formats. Our project encompasses an [extensive nine-volume book series](https://www.merianverlag.ch/buecher/stadt.geschichte.basel.html), an overview volume, a digital portal, and a digital platform for research data. Hosted at the University of Basel, this project aims to make historical research and insights accessible to scholars and the public like never before. -This project is the open source code of the digital portal of Stadt.Geschichte.Basel. It is a static website built with [SvelteKit](https://kit.svelte.dev/). The website is hosted on [Cloudflare Pages](https://pages.cloudflare.com/). It uses [hypotheses.org](https://sgb.hypotheses.org/) as CMS and consumes data from [Agendabasel](https://agendabasel.ch/) for the agenda. +This project is the open-source code of the digital portal of Stadt.Geschichte.Basel. It is a static website built with [SvelteKit](https://kit.svelte.dev/) and hosted on [Cloudflare Pages](https://pages.cloudflare.com/). It uses [hypotheses.org](https://sgb.hypotheses.org/) as CMS and consumes data from [Agendabasel](https://agendabasel.ch/) for the agenda. The digital platform for research data can be found at [forschung.stadtgeschichtebasel.ch](https://forschung.stadtgeschichtebasel.ch/). The source code for the digital platform can be found [here](https://github.com/Stadt-Geschichte-Basel/forschung.stadtgeschichtebasel.ch). ## Key Features - **Fast Static Website**: The website is built with SvelteKit, providing a fast and responsive user experience. -- **Interactive Features**: The website includes an interactive map, and agenda. -- **Accessibility-Focused Design**: Ensuring inclusivity for all users, by complying with WCAG standards and observing neurodiversity design guidelines. More at our [accessibility statement](https://stadtgeschichtebasel.ch/barrierefreiheit/). +- **Interactive Features**: The website includes an interactive map and agenda. +- **Accessibility-Focused Design**: Ensuring inclusivity for all users by complying with WCAG standards and observing neurodiversity design guidelines. More at our [accessibility statement](https://stadtgeschichtebasel.ch/barrierefreiheit/). ![Lighthouse Score](/assets/images/pagespeed-insights.svg) @@ -70,7 +70,7 @@ pnpm run format ## Support -This project is maintained by [@Stadt-Geschichte-Basel](https://github.com/Stadt-Geschichte-Basel). Please understand that we won't be able to provide individual support via email. We also believe that help is much more valuable if it's shared publicly, so that more people can benefit from it. +This project is maintained by [@Stadt-Geschichte-Basel](https://github.com/Stadt-Geschichte-Basel). Please understand that we won't be able to provide individual support via email. We believe that help is much more valuable if it's shared publicly, so that more people can benefit from it. | Type | Platforms | | -------------------------------------- | --------------------------------------------------------------------------------------------------- | From f9aed9460e8b8c541fa0eb655593810e96e74ff5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20M=C3=A4hr?= Date: Fri, 19 Apr 2024 16:59:10 +0200 Subject: [PATCH 08/10] fix: Update README.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5f737fa6..e4637629 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # stadtgeschichtebasel.ch -The open-source code of the digital portal of Stadt.Geschichte.Basel. +The open-source code of the digital portal of Stadt.Geschichte.Basel. [![GitHub issues](https://img.shields.io/github/issues/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch.svg)](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/issues) [![GitHub issues](https://img.shields.io/github/issues/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch.svg)](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/issues) [![GitHub forks](https://img.shields.io/github/forks/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch.svg)](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/network) From df6998c8a40cbc0870edd27229f8ac007b12eb92 Mon Sep 17 00:00:00 2001 From: Moritz Twente <127845092+mtwente@users.noreply.github.com> Date: Fri, 19 Apr 2024 18:01:07 +0200 Subject: [PATCH 09/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e4637629..5f737fa6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # stadtgeschichtebasel.ch -The open-source code of the digital portal of Stadt.Geschichte.Basel. [![GitHub issues](https://img.shields.io/github/issues/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch.svg)](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/issues) +The open-source code of the digital portal of Stadt.Geschichte.Basel. [![GitHub issues](https://img.shields.io/github/issues/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch.svg)](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/issues) [![GitHub forks](https://img.shields.io/github/forks/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch.svg)](https://github.com/Stadt-Geschichte-Basel/stadtgeschichtebasel.ch/network) From ba05e9bbda7b3b55e1c94d5c20dd334737539c8b Mon Sep 17 00:00:00 2001 From: Moritz Twente <127845092+mtwente@users.noreply.github.com> Date: Fri, 19 Apr 2024 18:01:20 +0200 Subject: [PATCH 10/10] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5f737fa6..d5de9d28 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ The digital platform for research data can be found at [forschung.stadtgeschicht - **Fast Static Website**: The website is built with SvelteKit, providing a fast and responsive user experience. - **Interactive Features**: The website includes an interactive map and agenda. -- **Accessibility-Focused Design**: Ensuring inclusivity for all users by complying with WCAG standards and observing neurodiversity design guidelines. More at our [accessibility statement](https://stadtgeschichtebasel.ch/barrierefreiheit/). +- **Accessibility-Focused Design**: Ensuring inclusivity for all users by complying with WCAG standards and observing neurodiversity design guidelines. More at our [accessibility statement](https://stadtgeschichtebasel.ch/barrierefreiheitserklaerung/). ![Lighthouse Score](/assets/images/pagespeed-insights.svg)