Skip to content

Latest commit

 

History

History
129 lines (91 loc) · 4.98 KB

README.md

File metadata and controls

129 lines (91 loc) · 4.98 KB

ELIXIR Cloud Components

ELIXIR Cloud Components (ECC) are lightweight, fast and reusable Web Components for operationalizing various ELIXIR Cloud & AAI and GA4GH Cloud services.

License Chat

Packages

Name Description
@elixir-cloud/design Encapsulation & Utility components to manage the headless yet constitent design accross ecc components
@elixir-cloud/tes Collection of Web Components for interacting with TES (Task Execution Service)
@elixir-cloud/wes Collection of Web Components for interacting with WES (Workflow Execution Service)

Development Setup

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn

Getting Started

  1. Clone the repository:

    git clone https://github.com/elixir-cloud-aai/cloud-components.git

  2. Install dependencies:

    npm install

  3. Start the development server:

    • Run the design package first as it is required by all other packages as dependency:

      npm run dev --workspace=@elixir-cloud/design

    • Run the specific package of choice from here:

      npm run dev --workspace=@elixir-cloud/<package-name>

      e.g.

      npm run dev --workspace=@elixir-cloud/tes

Contributing

This project is a community effort and lives off your contributions, be it in the form of bug reports, feature requests, discussions, fixes or any other form of contribution!

Please refer to the guidelines available at CONTRIBUTING.md if you are interested in contributing.

Code of Conduct

Please mind the code of conduct described in CODE_OF_CONDUCT.md for all interactions with the community. Please be nice to one another! :)

If you experience any unacceptable behavior by any member of the community, please refer to the contact method specified in CODE_OF_CONDUCT.md to report the incident to the community leaders.

Versioning

The project adopts the semantic versioning scheme for versioning. Currently the service is in a pre-release stage, so changes to the API, including breaking changes, may occur at any time without further notice.

License

This project is distributed under the Apache License 2.0, a copy of which is also available in LICENSE.

Contact

The project is maintained by ELIXIR Cloud & AAI, a Driver Project of the Global Alliance for Genomics and Health (GA4GH), under the umbrella of the ELIXIR Compute Platform.

To get in touch with use, please use one of the following routes:

  • For filing bug reports, feature requests or other code-related issues, please make use of the project's issue tracker.
  • For private/personal issues, more involved communication, or if you would like to join our team as a regular contributor, you can either join our chat board or email the community leaders.

logo-elixir logo-elixir-cloud-aai