-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): Add some information on this monorepo
- Loading branch information
Showing
1 changed file
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# GAAS Monorepo | ||
|
||
## Overview | ||
|
||
This monorepo contains all projects and packages related to GAAS (Galaxy As a Service), which provides tooling and interfaces for the [Galaxy Project](https://github.com/galaxyproject). | ||
|
||
The Galaxy Project is an open-source platform for: | ||
|
||
- Data-intensive biomedical research | ||
- Reproducible scientific workflows | ||
- Web-based analysis and visualization tools | ||
- REST API for programmatic interactions | ||
|
||
## Repository Structure | ||
|
||
The monorepo consists of three main packages: | ||
|
||
### **blendtype** | ||
|
||
- TypeScript client for Galaxy Project REST API | ||
- Provides type-safe interactions with Galaxy servers | ||
- Similar to BioBlend but with full TypeScript support | ||
- Handles authentication and workflow invocations | ||
- Built to be tree-shakeable and modular | ||
|
||
### **nuxt-galaxy** | ||
|
||
- Nuxt module that integrates with Galaxy Project | ||
- Leverages blendtype for Galaxy API communication | ||
- Simplifies Galaxy integration in Nuxt applications | ||
- Features: | ||
- Authentication handling and data persistence with Supabase | ||
- Workflow execution management | ||
- Workflow monitoring | ||
|
||
### **gaas-ui** | ||
|
||
- Nuxt layer built on top of nuxt-galaxy | ||
- Provides pre-built pages and layouts | ||
- Ready-to-use components for Galaxy interactions | ||
- UI components for: | ||
- Dataset browsers | ||
- Job monitoring dashboards | ||
- Tool interfaces | ||
|
||
## Resources | ||
|
||
- [Galaxy Project Documentation](https://docs.galaxyproject.org) | ||
- [Galaxy API Documentation](https://docs.galaxyproject.org/en/latest/api/api.html) | ||
- [Galaxy Training Network](https://training.galaxyproject.org) | ||
- [Galaxy Community Hub](https://galaxyproject.org) | ||
|
||
## Contributing | ||
|
||
Please see the contributing guidelines in each package for development setup and contribution workflows. | ||
|
||
## License | ||
|
||
This project is MIT licensed. See the LICENSE file in each package for details. |