Genome-browser-hnd NPM

About The Project

Inspired by "igv" and "varsome" genome browsers, I built an interactive genome browser tool from scratch using Reactjs which helps bioinformatics researchers visualize and analyze their data.

Built With

Frameworks/libraries used to bootstrap this project.

Getting Started

To get a local copy up and running follow these simple example steps.

Scripts

Clone the repo

git clone https://github.com/lebinh190998/genome-browser.git

Install NPM packages
```
npm install
```

Run server file

cd server/

python genome_browser_server.py

Run locally
```
npm start
```
Build production version (Optional)
```
npm run build
```

Use as a package

View Package

Download genome-browser package
```
npm install genome-browser
```

Import into your project

import { GenomeBrowserApp } from 'genome-browser';

Use the application as a component
```
<div>
  <GenomeBrowserApp />
</div>
```
Some useful props you can use
a. Choose desired chromosome
```
<GenomeBrowserApp chrNum='chr1' />
```
b. Choose desired human genome: 'hg38' or 'hg19'
```
<GenomeBrowserApp id='hg38' />
```
c. Host your own server with your genome data
```
<GenomeBrowserApp serverUrl='http://3.143.149.107:8000' />
```
d. Choose your preferred starting and ending positions:
```
<GenomeBrowserApp pos1='1287123' pos2='1287193' />
```

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!