Skip to content

Commit

Permalink
chore: docs
Browse files Browse the repository at this point in the history
  • Loading branch information
anuragxxd committed Feb 3, 2025
1 parent 4a03f88 commit d143047
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 9 deletions.
49 changes: 43 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,49 @@ ELIXIR Cloud Components (ECC) are lightweight, fast and reusable Web Components

| Name | Description |
|----------------------------|--------------------------------------------------------------------------------------------------------|
| ecc-utils-design | Encapsulation & Utility components to manage the headless yet constitent design accross ecc components |
| ecc-client-ga4gh-tes | Collection of Web Components for interacting with TES (Task Execution Service) |
| ecc-client-ga4gh-wes | Collection of Web Components for interacting with WES (Workflow Execution Service) |
| ecc-client-ga4gh-trs | Collection of Web Components for interacting with TRS (Tool Registry Service) |
| ecc-client-ga4gh-trs-filer | Collection of Web Components for interacting with Elixir TRS Filer |
| eslint-config | Custom & common eslint configuration for elixir packages |
| @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:

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

2. Install dependencies:

```bash
npm install
```

3. Start the development server:

- Run the design package first as it is required by all other packages as dependency:
```bash
npm run dev --workspace=@elixir-cloud/design
```
- Run the specific package of choice from [here](#packages):

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

e.g.
```bash
npm run dev --workspace=@elixir-cloud/tes
```



## Contributing

Expand Down
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit d143047

Please sign in to comment.