sanyam2000-dot / cloud-components

Reusable components for the ELIXIR Cloud

ELIXIR Cloud Components

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

Introduction

This repository follows the monorepo architecture (using TurboRepo) that follows the common convention of having having top-level apps/ and packages/ directories. The packages folder should contain workspaces for packages used by either an app or another package. The apps folder should contain workspaces for launchable apps, such as a Next.js or Svelte app.

Workspaces are the building blocks of your monorepo. Each app and package you add to your monorepo will be inside its own workspace.

Packages

Name	Description	Version	Status
ecc-utils-design	Encapsulation & Utility components to manage the headless yet constitent design accross ecc components	0.0.1	In progress
ecc-client-ga4gh-tes	Collection of Web Components for interacting with TES (Task Execution Service)	0.0.1	In progress
ecc-client-ga4gh-trs	Collection of Web Components for interacting with TRS (Tool Registry Service)	0.0.1	In progress
eslint-config-elixir	Custom & common eslint configuration for elixir packages	0.0.1	In progress

Getting Started

To get started with this project, follow these steps:

Note: All of the following commands should be executed on all the packages & apps. In case you want to execute the script on any one particular app/package, you can define the workspace tag along with any of the below commands like -w=ecc-utils-design.

1. Install the dependencies involved by running the following command:

   npm install
   

2. Run the development server by running the following command:

   npm run dev
   

   This will start the development server on your local machine and allow you to start working on the project.

3. If you want to start a new package run:

   npm run new
   

4. Run linter by the following command:

   npm run lint
   

5. Run all test using the following command.

   npm run test
   

Note: Since packages have interdependency, you need to run dev script atleast once before running lint and test scripts globally.

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.

Contributors

We believe that any contribution should be duly acknowledged. Therefore, we implement the All Contributors Specification and encourage you to comment on any issue or PR you contributed to with a request to the @all-contributors bot of the form @all-contributors please add @<YOUR_GITHUB_HANDLE for TYPE_1, TYPE_2, ..., where TYPE_1 etc. refer to contribution types supported by the All Contributors Specification.

Information about contributors, including information about the specific they have made to the project, are listed in CONTRIBUTORS.md.

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][res-semver] 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][issues].
• For more general discussions or questions on usage, please use the organization's [discussion forum][forum]. If the issue is related to this project, please indicate its name in your message body.
• 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 send an email to the community leaders.