Open Know-How (OKH) wants to make hardware projects easier to find through a standardised data interchange format. Read more about it here.
This site is a prototype for a federated search using the OKH format. Have a look at the design docs for more details on the thinking behind it.
You can directly edit the okh-config.json on this site and add a URL of your OKH compliant manifest under the remoteManifests
field. Alternatively you can add your project to one of the community sites listed above (or make your own community site!).
If you don't want to host the .yml manifest yourself you can add a local-manifests/
folder in this repo and put the .yml file in there.
You can either use this template for a static Next.js site or add an OKH compliant API to any site.
npx create-next-app -e https://github.com/iop-alliance/okh-search my-okh-site
Replace public/logo.svg
and public/favicon.png
with your own images.
Edit okh-config.json
, including:
title
- The page title.description
- A description of what the page is for.url
- The URL of the site when it will be deployed.remoteLists
- URLs of any list of manifest JSON endpoints that you would like to include in your page.remoteManifests
- OKH manifests of projects you want to include.If you want to add manifests locally add a folder called local-manifests/
and put .yml files in there.
Install dependencies
npm install
npm run get-data
npm run dev
Visit http://localhost:3000 to see it.
npm run build && npm run export
okh-config.json
on iop-alliance/okh-search and add your ${your-site}/manifests/list.json
to the remoteLists
field. This will add the projects from your site to https://search.openknowhow.org.okh-config.json
on iop-alliance/okh-search and add your ${your-site}/manifests/list.json
to the remoteLists
field. This will add the projects from your site to https://search.openknowhow.org.This project is funded through the NGI0 Discovery Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 825322.