Skip to content

Latest commit

 

History

History
100 lines (63 loc) · 5.76 KB

README.md

File metadata and controls

100 lines (63 loc) · 5.76 KB

stadtgeschichtebasel.ch

The open-source code of the digital portal of Stadt.Geschichte.Basel.

GitHub issues GitHub forks GitHub stars GitHub license

Overview

Welcome to Stadt.Geschichte.Basel, 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 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 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. 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 and hosted on Cloudflare Pages. It uses hypotheses.org as CMS and consumes data from Agendabasel for the agenda.

The digital platform for research data can be found at forschung.stadtgeschichtebasel.ch. The source code for the digital platform can be found here.

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.

Lighthouse Score

Installation

Use the package manager pnpm to install all dependencies.

pnpm install

Run the prebuild script to download the pages, posts, and assets from hypotheses.org.

pnpm run prebuild

Usage

Run the development server.

pnpm run dev

Build for production.

pnpm run build

Optimize the build with Jampack for production.

rm -Rf build/_jampack/ && pnpm run postbuild # FIXME: Quick fix to make jampack work

Development

To check the code and format it.

pnpm run check
pnpm run format

Support

This project is maintained by @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
🚨 Bug Reports GitHub Issue Tracker
🎁 Feature Requests GitHub Issue Tracker
🛡 Report a security vulnerability GitHub Issue Tracker
💬 General Questions GitHub Discussions

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors and acknowledgment

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE.md file for details.