Skip to content

MellonScholarlyCommunication/researcher-pod-setup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Researcher Pod Setup

This repository contains a NodeJS script that can be used to setup a researcher pod based on the Researcher Pod spec for the Mellon project.

First, it will create a new pod for the researcher. Then, it will set up a Linked Data Event Stream in the created Pod automatically using the LDES in LDP library.

Installation and Usage

First, clone the project and install the dependencies:

git clone [email protected]:MellonScholarlyCommunication/researcher-pod-setup.git
cd researcher-pod-setup
npm install
npm run build

Then, make sure you have a Solid server running, exposing the ldes:EventStream the script will create on all the resources as a Link Header. Therefor, you can use the semi-constant-headers-writer-component for the Community Solid Server (CSS).

A working configuration of the CSS with this component can be found in the solid-server folder. More information about this configuration can be found in the README of that folder. You can use Docker and docker-compose to run the CSS with this configuration:

cd solid-server
docker-compose up -d
cd ..

Then, you can run the script:

# To provide the input interactively
node bin/index.js

# Or you can provide the input as arguments
node bin/index.js -u <Solid server URL> -n <name of newly created Solid account> -e <Email address for the user> -p <User password> -i <Relative LDES in LDP identifier>

# For example:
node bin/index.js -u http://localhost:3000 -n researcher-test -e researcher-test@example -p researcher-test -i ldesinldp/

# Only the first 2 arguments are required, the others have defaults, so you could also run:
node bin/index.js -u http://localhost:3000 -n researcher-test

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published