Contributor’s Guide

Do you want to help make ViRelAy even better? There are many ways to contribute, and this guide will walk you through everything you need to know to improve ViRelAy. This section will outline the architecture of ViRelAy, including the backend REST API and the frontend web application, the file format used to describe ViRelAy projects, and the database specification for storing the project data. It will also guide you through everything you need to know to submit code changes, improve our documentation, and other contributions. We appreciate your interest in helping us improve ViRelAy!

• Contributing to ViRelAy
  • Reporting Issues & Feature Requests
  • Contributing Code or Documentation
• Backend REST API Architecture
  • Managing the Backend REST API Project
  • Command Line Interface
  • REST API
  • Unit Testing
  • Linting
  • Building
• Frontend Web App
  • Development Environment Setup
  • Building the Frontend
  • Linting
• Project File Format
• Database Specification
  • Legend
  • General Data Specification
  • Model Input Data
  • Attribution of Input Data
  • Analysis Output Data