Skip to content

Commit d143047

Browse files
committed
chore: docs
1 parent 4a03f88 commit d143047

File tree

2 files changed

+46
-9
lines changed

2 files changed

+46
-9
lines changed

README.md

Lines changed: 43 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,49 @@ ELIXIR Cloud Components (ECC) are lightweight, fast and reusable Web Components
1616

1717
| Name | Description |
1818
|----------------------------|--------------------------------------------------------------------------------------------------------|
19-
| ecc-utils-design | Encapsulation & Utility components to manage the headless yet constitent design accross ecc components |
20-
| ecc-client-ga4gh-tes | Collection of Web Components for interacting with TES (Task Execution Service) |
21-
| ecc-client-ga4gh-wes | Collection of Web Components for interacting with WES (Workflow Execution Service) |
22-
| ecc-client-ga4gh-trs | Collection of Web Components for interacting with TRS (Tool Registry Service) |
23-
| ecc-client-ga4gh-trs-filer | Collection of Web Components for interacting with Elixir TRS Filer |
24-
| eslint-config | Custom & common eslint configuration for elixir packages |
19+
| @elixir-cloud/design | Encapsulation & Utility components to manage the headless yet constitent design accross ecc components |
20+
| @elixir-cloud/tes | Collection of Web Components for interacting with TES (Task Execution Service) |
21+
| @elixir-cloud/wes | Collection of Web Components for interacting with WES (Workflow Execution Service) |
22+
23+
## Development Setup
24+
25+
### Prerequisites
26+
27+
- Node.js (v16 or higher)
28+
- npm or yarn
29+
30+
### Getting Started
31+
32+
1. Clone the repository:
33+
34+
```bash
35+
git clone https://github.com/elixir-cloud-aai/cloud-components.git
36+
```
37+
38+
2. Install dependencies:
39+
40+
```bash
41+
npm install
42+
```
43+
44+
3. Start the development server:
45+
46+
- Run the design package first as it is required by all other packages as dependency:
47+
```bash
48+
npm run dev --workspace=@elixir-cloud/design
49+
```
50+
- Run the specific package of choice from [here](#packages):
51+
52+
```bash
53+
npm run dev --workspace=@elixir-cloud/<package-name>
54+
```
55+
56+
e.g.
57+
```bash
58+
npm run dev --workspace=@elixir-cloud/tes
59+
```
60+
61+
2562

2663
## Contributing
2764

package-lock.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)