An open API service indexing awesome lists of open source software.

https://github.com/overture-stack/arranger

Data portal API and component generation
https://github.com/overture-stack/arranger

data-portal data-portal-frontends

Last synced: about 1 month ago
JSON representation

Data portal API and component generation

Awesome Lists containing this project

README

          

# Arranger

Arranger is a versatile, data-agnostic GraphQL search API that leverages Elasticsearch, designed to simplify the process of creating powerful search interfaces for complex datasets. It's accompanied by its own React component library to generate interactive and highly configurable search UIs.

>
>
> _Arranger is part of [Overture](https://www.overture.bio/), a collection of open-source software microservices used to create platforms for researchers to organize and share genomics data._

## Documentation

Technical resources for those working with or contributing to the project are available from our official documentation site, the following content can also be read and updated within the `/docs` folder of this repository.

- **[Arranger Overview](https://docs.overture.bio/docs/core-software/Arranger/overview)**
- [**Setting up the Development Enviornment**](https://docs.overture.bio/docs/core-software/Arranger/setup)
- [**Common Usage Docs**](https://docs.overture.bio/docs/core-software/Arranger/setup)

## Development Environment

- [Node.js](https://nodejs.org/) (v22 or higher)
- [Docker](https://www.docker.com/) (v4.39.0 or higher)

## Support & Contributions

- For support, feature requests, and bug reports, please see our [Support Guide](https://docs.overture.bio/community/support).
- For detailed information on how to contribute to this project, please see our [Contributing Guide](https://docs.overture.bio/docs/contribution).

## Related Software

The Overture platform includes the following components:

| Software | Description |
| ------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| [Score](https://github.com/overture-stack/score/) | Transfer data to and from any cloud-based storage system |
| [Song](https://github.com/overture-stack/song/) | Catalogue and manage metadata associated to file data spread across cloud storage systems |
| [Maestro](https://github.com/overture-stack/maestro/) | Organizing your distributed data into a centralized Elasticsearch index |
| [Arranger](https://github.com/overture-stack/arranger/) | A search API with reusable UI components |
| [Stage](https://github.com/overture-stack/stage) | A React-based web portal scaffolding |
| [Lyric](https://github.com/overture-stack/lyric) | A model-agnostic, tabular data submission system |
| [Lectern](https://github.com/overture-stack/lectern) | Schema Manager, designed to validate, store, and manage collections of data dictionaries. |

If you'd like to get started using our platform [check out our quickstart guides](https://docs.overture.bio/guides/getting-started)

## Funding Acknowledgement

Overture is supported by grant #U24CA253529 from the National Cancer Institute at the US National Institutes of Health, and additional funding from Genome Canada, the Canada Foundation for Innovation, the Canadian Institutes of Health Research, Canarie, and the Ontario Institute for Cancer Research.