Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🛠️ [TASK] : Document Hermes application packaging requirements #70

Closed
Tracked by #129
saibatizoku opened this issue Jan 25, 2024 · 0 comments · Fixed by #71
Closed
Tracked by #129

🛠️ [TASK] : Document Hermes application packaging requirements #70

saibatizoku opened this issue Jan 25, 2024 · 0 comments · Fixed by #71
Assignees
Labels
documentation Pull requests that update a dependency file.

Comments

@saibatizoku
Copy link
Contributor

Summary

Describe Hermes application packaging requirements using HDF5

Description

Applications

  • Metadata Describing the Application.
    • Name
    • Author
    • Icons
    • Description
    • Configuration
    • etc
  • Static Files which can be served AS-IS to a local host over HTTP.
  • Static Data which can be used by Webasm Modules.
  • Webasm Modules to Implement the Dynamic Functionality of the application.
  • Signature: All Data in the application needs to be able to be signed for authentication purposes.

Applications are read only. The data within the Application can not be updated as it is run.

Static Files

A large part of any web application is a collection of static assets such as:

  • Images.
  • HTML / CSS.
  • Javascript / Webasm to execute in the browser.
  • This is such a common use case that the Hermes should have the in-built capability to serve these files from a known SUB DOMAIN and path used by the application.

The Webasm modules would ALSO be able to read this data.

Static Files

This is data which the Dynamic Functionality provided by the WebAsm Modules needs in order to do its job. An example could be javascript files which are templated and need to be processed before serving. The type and kind of these files is unbounded, but necessary for lots of application purposes.

These files are NOT directly accessible over HTTP from the Application but can be read from the Webasm.

Webasm Modules

Webasm Modules are a kind of Mini Application and they will need:

  • Metadata describing the module.

    • Name
    • Author
    • URL of the Source
    • Configuration
    • etc
  • Static Data that can ONLY be used by the Module itself.

    • Examples could be tabular data.
  • The Webasm binary code itself.

  • Signature: All Data in the webasm module needs to be able to be signed for authentication purposes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests that update a dependency file.
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

2 participants