Elixir Cloud & AII Web Components

Description

GA4GH Web components are the reusable custom elements that can be utilized in your web apps & web pages independently irrespective of what framework/library you are using to build the frontend. These components will mainly serve the Elixir Cloud & AII for managing their services.

Getting Started

Prerequisites

• Git
• Node & npm: Recent LTS version avaliable
• A fork of the repo (for any contributions)

Installation

• To start with, fork & clone the repository and traverse into the service's root directory with:

git clone https://github.com/<your-github-username>/web-components.git
cd web-components

• Install the packages to be used in the development:

npm install

• Build CSS for the project:

npm run build:css

• Run start script to start the development enviroment of project:

npm run start

• This will open the browser window on desktop. If not visit http://localhost:3333/ on your browser new window.

Great, Now you are good to go!

Contributing

This project is a community effort and lives off your contributions, be it in the form of bug reports, feature requests, discussions, or fixes and other code changes. Please refer to our organization's contribution guidelines if you are interested in contributing. Please mind the code of conduct for all interactions with the community.

Versioning

The project adopts the semantic versioning scheme for versioning. Currently the service is in development v1 package for the same will be out soon. Stay tuned!

License

This project is covered by the MIT License also shipped with this repository.

Contact

The project is a collaborative effort under the umbrella of ELIXIR Cloud & AAI. Follow the link to get in touch with us via chat or email. Please mention the name of this service for any inquiry, proposal, question etc. Alternatively, you can also make use of the issue tracker to request features or report bugs.