Skip to content

grycap/oscar-hub

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧠 OSCAR Hub

Welcome to OSCAR Hub, a repository of ready-to-deploy services for the OSCAR platform. Each service is defined using the RO-Crate standard, including structured metadata, deployment scripts, and FDL definitions.


🚀 What's in this repository?

  • 📂 Inside the cratesfolder, a collection of directories, each representing a deployable OSCAR service.
  • 📄 Inside each directory:
    • ro-crate-metadata.json: Service description using the RO-Crate format.
    • fdl.yml: Service definition using the Functions Definition Language (FDL).
    • script.sh: Script to be executed upon service invocation.

📦 Adding a New Service

  1. Create a new directory named after your service.
  2. Copy the contents of crates/template into the new directory and adjust the placeholders.
  3. Ensure the directory includes:
    • ro-crate-metadata.json
    • fdl.yml
    • script.sh
  4. Validate your RO-Crate before submitting a pull request.

🧰 Metadata validation

To validate the services defined via RO-Crate:

pip install roc-validator

Then run:

rocrate-validator validate -p ro-crate-1.1 --verbose --no-paging ./<service>

A GitHub action has been configured to automatically validate new entries submitted via PRs.


🏗️ Local development

  1. Install dependencies:

    npm install
  2. Start the development server:

    npm run dev

    The script builds the site, serves the dist output, and watches for changes. By default it listens on http://localhost:4173; set the PORT environment variable to use a different port.

To produce a static bundle without the dev server, run npm run build to regenerate dist/.


📄 License

Each service can define its own license. Make sure to include it in the RO-Crate metadata when applicable.


🤝 Contributing

Contributions are welcome! Please open an issue or a pull request to suggest improvements or add new services.


📬 Contact: GRyCAP - Universitat Politècnica de València

About

Curated OSCAR services definitions (based on RO-CRATE)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •