Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: readme enhanced #117

Merged
merged 15 commits into from
Apr 19, 2024
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,24 @@ 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)

## 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.
maehr marked this conversation as resolved.
Show resolved Hide resolved

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.
maehr marked this conversation as resolved.
Show resolved Hide resolved

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).

maehr marked this conversation as resolved.
Show resolved Hide resolved
## 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/).
maehr marked this conversation as resolved.
Show resolved Hide resolved

![Lighthouse Score](/assets/images/pagespeed-insights.svg)

## Installation

Use the package manager [pnpm](https://pnpm.io/installation) to install all dependencies.
Expand All @@ -15,7 +33,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/).
maehr marked this conversation as resolved.
Show resolved Hide resolved
maehr marked this conversation as resolved.
Show resolved Hide resolved

```bash
pnpm run prebuild
Expand All @@ -29,13 +47,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
Expand Down Expand Up @@ -73,6 +91,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.

Expand Down
231 changes: 231 additions & 0 deletions assets/images/pagespeed-insights.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading