Frequently Asked Questions

Getting Started

What is the Sage Monorepo?

The Sage Monorepo is a comprehensive development platform for building biomedical research applications. It provides shared components, modern tooling, and standardized development practices across multiple programming languages and frameworks.

How do I get started?

Check out our Quick Start Guide to set up your local development environment. For a deeper understanding, explore our Architecture Overview.

What technologies are supported?

We support:

• Frontend: TypeScript, Angular, React
• Backend: Java (Spring Boot), Python (Flask), R (Shiny)
• Databases: PostgreSQL, MongoDB
• Infrastructure: Docker, Kubernetes, AWS

Development

How do I create a new project?

Follow our technology-specific tutorials:

• Angular App
• Java REST API
• Python REST API
• Docker Project

How do I share code between projects?

Use our library creation guides:

• Angular Library
• Java Library

Can I develop remotely?

Yes! We support remote development through:

• Dev Containers
• Remote Host Development

Platform & Services

What services are available?

See our Service Catalog for a complete list of all 145 projects, or explore our main products:

• Agora
• OpenChallenges

How do I access the APIs?

All our APIs are documented in the API section. Each service provides OpenAPI specifications and client libraries.

Where can I find API documentation?

API documentation is auto-generated and available for:

• Agora API
• AMP-ALS API
• BixArena API
• Model-AD API
• OpenChallenges API
• Synapse API

Contributing

How can I contribute?

We welcome contributions! Check out our Contributing Guidelines to get started. You can:

• Report bugs using our Bug Report Template
• Request features using our Feature Request Guidelines
• Submit pull requests with improvements

How do I report issues?

Use our GitHub Issues page. Please use the appropriate template:

• Bug reports
• Feature requests
• Documentation improvements

Can I collaborate with multiple authors on commits?

Yes! See our guide on Creating Multi-author Commits.

Troubleshooting

My local setup isn't working

Common solutions:

1. Ensure you have the required dependencies installed
2. Check that your environment variables are set correctly
3. Verify your Docker setup if using containers
4. Review the local development guide

Build or test failures

1. Clear your cache: nx reset
2. Reinstall dependencies: pnpm install
3. Check for any environment-specific requirements
4. Review recent changes that might affect your project

API connection issues

1. Verify your API endpoints and credentials
2. Check network connectivity
3. Review the specific API documentation
4. Ensure you're using the correct API version

Updates & News

How do I stay updated?

• Follow our Updates page for the latest announcements
• Subscribe to our Blog for technical insights
• Watch our GitHub repository for releases

Where can I find release notes?

Check our Updates page for version-specific release notes and feature announcements.

Still Need Help?

If you can't find the answer to your question:

1. Search our GitHub Issues
2. Create a new issue with the appropriate template
3. Contact our development team through GitHub

---

This FAQ is continuously updated. If you think a question should be added, please let us know!