Skip to content

chore: cleanup #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 23 commits into from
Apr 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions .changeset/eight-terms-judge.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/few-gorillas-battle.md

This file was deleted.

7 changes: 0 additions & 7 deletions .changeset/honest-sloths-hide.md

This file was deleted.

1 change: 0 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,3 @@ CONTRIBUTORS.md
CODE_OF_CONDUCT.md

/packages/*
```
4 changes: 0 additions & 4 deletions .husky/commit-msg

This file was deleted.

5 changes: 1 addition & 4 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,4 @@
. "$(dirname -- "$0")/_/husky.sh"

# run the lint command
npm run lint

# run the test command
npm run test
npm run lint
4 changes: 0 additions & 4 deletions .husky/prepare-commit-msg

This file was deleted.

1 change: 0 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@ LICENSE
README.md
CONTRIBUTORS.md
CODE_OF_CONDUCT.md
```
Empty file removed CONTRIBUTING.md
Empty file.
81 changes: 13 additions & 68 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,69 +12,17 @@ ELIXIR Cloud Components (ECC) are lightweight, fast and reusable Web Components
[![All Contributors][badge-all-contributors-image]][contributors]
[![Chat][badge-chat-image]][badge-chat-url]

## Introduction

This repository follows the monorepo architecture (using [TurboRepo](https://turbo.build/repo)) 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](https://nextjs.org/) or [Svelte](https://svelte.dev/) 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 |

<!-- ### Apps

| 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]() |

-->

## 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](https://turbo.build/repo/docs/handbook/package-installation#addingremovingupgrading-packages) 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.
| 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-elixir | Custom & common eslint configuration for elixir packages |

## Contributing

Expand Down Expand Up @@ -111,7 +59,7 @@ leaders.

## Versioning

The project adopts the [semantic versioning][res-semver] scheme for versioning.
The project adopts the [semantic versioning](https://semver.org/) 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.

Expand All @@ -129,13 +77,10 @@ the umbrella of the [ELIXIR][elixir] [Compute Platform][elixir-compute].
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.
make use of the project's [issue tracker](https://github.com/elixir-cloud-aai/cloud-components/issues).
- 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][badge-chat-url] or send an [email][email] to the community
[chat board][badge-chat-url] or [email] the community
leaders.

[![logo-elixir][logo-elixir]][elixir]
Expand All @@ -148,9 +93,9 @@ To get in touch with use, please use one of the following routes:
[badge-license-url]: http://www.apache.org/licenses/LICENSE-2.0
[badge-chat-image]: https://img.shields.io/static/v1?label=chat&message=Slack&color=ff6994
[badge-chat-url]: https://join.slack.com/t/elixir-cloud/shared_invite/enQtNzA3NTQ5Mzg2NjQ3LTZjZGI1OGQ5ZTRiOTRkY2ExMGUxNmQyODAxMDdjM2EyZDQ1YWM0ZGFjOTJhNzg5NjE0YmJiZTZhZDVhOWE4MWM
[email]: [email protected]
[email]: mailto:[email protected]
[code-of-conduct]: CODE_OF_CONDUCT.md
[contributing]: CONTRIBUTING.md
[contributing]: https://elixir-cloud-aai.github.io/guides/guide-contributor/
[contributors]: CONTRIBUTORS.md
[elixir]: https://elixir-europe.org/
[elixir-cloud-aai]: https://elixir-cloud.dcc.sib.swiss/
Expand Down
17 changes: 0 additions & 17 deletions apps/documentation/.gitignore

This file was deleted.

21 changes: 0 additions & 21 deletions apps/documentation/.prettierrc

This file was deleted.

21 changes: 0 additions & 21 deletions apps/documentation/LICENSE

This file was deleted.

130 changes: 0 additions & 130 deletions apps/documentation/docs/.vitepress/config.mts

This file was deleted.

Loading