Gene Curator

Gene Curator is an open-source platform designed for the curation and management of genetic information. This project provides tools for gene data analysis, visualization, and export, assisting researchers and clinicians in the field of genomics.

Table of Contents

• Installation
• Setup
• Usage
• Contributing
• Architecture
• Contact
• License

Installation

Clone the repository and install the dependencies:

git clone https://github.com/halbritter-lab/gene-curator.git
cd gene-curator
npm install

Ensure you have Node.js version 16.20.0 installed. This is the version that has been tested and is known to work with this project.

Setup

To set up the development environment, follow these steps:

# Run the development server
npm run serve

# Build for production
npm run build

Usage

Here are some examples of how to use the Gene Curator:

1. To view gene data:
   • Navigate to /genes on the application.
2. To manage gene data:
   • Access the admin panel at /admin.

Contributing

We welcome contributions from the community. Please follow our contributing guidelines and our code of conduct to contribute to the project.

Architecture

The project is built with:

• Vue.js (v3.2.13) - A progressive JavaScript framework.
• Vuetify (v3.4.8) - A Vue UI Library with beautifully handcrafted Material Components.
• Firebase (v10.7.1) - Backend-as-a-Service for app development.

Contact

For more information and further documentation, please contact us or visit our documentation.

License

Gene Curator is licensed under the MIT License - see the LICENSE file for details.