OME Readme

Distributed / Decentralized Network for Open Metadata Exchange

High Level "what connects to what"

sequenceDiagram
	participant Browser
	participant FE2-on-NodeServer
	participant FastAPI-Server
	participant InterNetNews

	Browser->>FE2-on-NodeServer: GET localhost:4000/imls
	FE2-on-NodeServer->>Browser: index.html from React app
	Browser->>FE2-on-NodeServer: API calls (it's proxied in DEV mode)
	FE2-on-NodeServer->>FastAPI-Server: Forwarded API calls
	FastAPI-Server->>InterNetNews: Query as appropriate
        InterNetNews->>FastAPI-Server: Metadata response
	FastAPI-Server->>FE2-on-NodeServer: API Data response
	FE2-on-NodeServer->>Browser: API Data response

Loading

Run the components

For local development and testing, start the INN2 server and FastAPI server with:

docker compose -f docker-compose.debug.yml up

• InterNetNews (INN) backend that houses the metadata.
  • https://www.isc.org/othersoftware/#INN
  • https://www.eyrie.org/~eagle/software/inn/docs-2.7
  • https://github.com/cclauss/apt-get-inn2-docker
• FastAPI-Server middle tier that connects the INN to the frontend.
• FE2 user interface that connects to the FastAPI-Server.

FE2 NodeServer

cd fe2
npm ci
npm run start
# Wait for `webpack x.y.z compiled successfully`
open http://localhost:4000/imls

Additional bits

For those wanting to "integrate" with OERCommons (either from the local dev environment, or - with some changes to the script - the production environment). Install tampermonkey if you're using Google Chrome, and then install the script that is in tools/monkeyscript/OERCommons.tampermonkey_script.js so that you get a button on OERCommons details page to export items from OERCommons into the locally running OME. This allows you to see how you might export - in a very proof-of-concept way - from your local library software to the OME.