stadt-geschichte-basel.github.io

This repository contains the documentation of the work of the team for research data management and digital education of Stadt.Geschichte.Basel.

Repository Structure

The structure of this repository follows the Advanced Structure for Data Analysis of The Turing Way and is organized as follows:

• assets/: Images, figures, and other media files.
• docs/: Documentation files, including the main README and other markdown files.
• products/: The final products of the project, such as reports, papers, or presentations.
• renv/: The R environment for the project, including package dependencies and versions.

Getting Started

We recommend using GitHub Codespaces for the easiest and fastest setup. It gives you a pre-configured, cloud-based development environment with everything ready to go directly in your browser.

Quick Start with GitHub Codespaces

1. Fork this repository to your GitHub account (if needed).

1. Click the green <> Code button at the top right of this repository.

2. Select the Codespaces tab and click Create codespace on main.

1. GitHub will now build a container that includes:

   • Node.js (via npm)
   • Python with uv
   • R with renv
   • Quarto

2. Once the Codespace is ready, you can preview the documentation locally inside the Codespace with:

   • Open a terminal in the Codespace (Terminal > New Terminal).
   • Run the following command to install all dependencies and preview the project:

bash uv run quarto preview

Local Setup

Use

Check that all files are properly formatted.

bash npm run check

Format all files.

bash npm run format

Run the wizard to write meaningful commit messages.

bash npm run commit

Run the wizard to create a CHANGELOG.md.

bash npm run changelog

Preview the documentation.

bash uv run quarto preview

Support

This project is maintained by @Stadt-Geschichte-Basel. Please understand that we can't provide individual support via email. We also believe that help is much more valuable when it's shared publicly, so more people can benefit from it.

| Type | Platforms | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | Bug Reports | GitHub Issue Tracker | | Report bad data | GitHub Issue Tracker | | Docs Issue | GitHub Issue Tracker | | Feature Requests | GitHub Issue Tracker | | Report a security vulnerability | See SECURITY.md | | General Questions | GitHub Discussions |

Roadmap

See https://github.com/orgs/Stadt-Geschichte-Basel/projects/5 for the current roadmap.

Contributing

All contributions to this repository are welcome! If you find errors or problems with the data, or if you want to add new data or features, please open an issue or pull request. Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

Versioning

We use SemVer for versioning. The available versions are listed in the tags on this repository.

Authors and acknowledgment

• Stadt.Geschichte.Basel - Stadt-Geschichte-Basel
• Moritz Mhr - maehr
• Moritz Twente - mtwente

See also the list of contributors who contributed to this project.

License

The data in this repository is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) License - see the LICENSE-CCBY file for details. By using this data, you agree to give appropriate credit to the original author(s) and to indicate if any modifications have been made.

The code in this repository is released under the GNU Affero General Public License v3.0 - see the LICENSE-AGPL file for details. By using this code, you agree to make any modifications available under the same license.