Skip to content

Commit

Permalink
docs(README): Add some information on this monorepo
Browse files Browse the repository at this point in the history
  • Loading branch information
rplanel committed Jan 7, 2025
1 parent cbb2c1a commit e8c94b9
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions README
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.

0 comments on commit e8c94b9

Please sign in to comment.