Open Hardware Repository 🐧

This repository hosts the sources of Open Hardware Repository website.

The website is built with Hugo using the Bigspring Light theme.

Build 🔨

Requirements 📋

• Go >= 1.23.10
• Hugo (the extended edition) >= 0.147.2
• Python >= 3.12.3
• PyYAML >= 6.0.2
• Pydantic >= 2.11.7
• email-validator >= 2.3.0
• Requests >= 2.32.5

Steps 👣

1. Clone the project

   git clone https://github.com/OHWR/ohwr.org.git

2. Go to the project directory

   cd ohwr.org

3. Build the website

   make build

   The website is stored in the public directory.

4. Serve the website

   make run

   To view the website, open the URL displayed in your terminal.

Test 🧪

Requirements 📋

• reuse >= 5.0.2
• wemake-python-styleguide >= 1.0.0
• yamllint >= 1.37.1
• checkmake >= 0.2.2
• markdownlint-cli2 >= 0.10.0
• pytest >= 8.4.1
• pytest-mock >=3.14.1

Steps 👣

1. Clone the project

   git clone https://github.com/OHWR/ohwr.org.git

2. Go to the project directory

   cd ohwr.org

3. Run the tests

   make test

Deployment 📡

The website is deployed to GitHub Pages with the GitHub Actions workflow defined in .github/workflows/deploy.yaml.

The workflow builds and deploys the website whenever a change is pushed to the master branch.

If errors are encountered while building the website, a warning is sent to the ohwr.org Mattermost channel.

Code of Conduct 📜

Please review our Code of Conduct to understand the expectations for behavior within the project community.

Security Policy 🔒

For information on our security policy and reporting vulnerabilities, please check our Security Policy.

Contributing Guidelines 🚀

We welcome contributions! Before getting started, please read our Contributing Guidelines for information on how to contribute to the project.