Elixir Cloud Components is lightweight, fast, and reusable web-components developed by Elixir Cloud and AAI Community for managing and accessing various services.
This repository follows the monorepo architecture (using TurboRepo) that follows the common convention of having having top-level apps/ and packages/ directories.
The apps folder should contain workspaces for launchable apps, such as a Next.js or Svelte app.
The packages folder should contain workspaces for packages used by either an app or another package.
Workspaces are the building blocks of your monorepo. Each app and package you add to your monorepo will be inside its own workspace.
| Name | Description | Version | Status |
|---|---|---|---|
| elixir-ui | This package serves as an abstraction layer for other packages, providing a streamlined approach for extracting common design token logic. | 0.0.1 | In progress |
| Name | Description | Deployment |
|---|---|---|
| example-usage | This application serves as a comprehensive guide for users on how to utilize the packages available in the sample app. | NA |
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.
-
Install the dependencies involved by running the following command:
npm install -
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.
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.
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.
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.
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.
This project is distributed under the Apache License 2.0, a
copy of which is also available in LICENSE.
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.
