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.

• React.js
• Python
• C++
• HTML Canvas
• MaterialUI

Getting Started

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

Scripts

1. Clone the repo

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

2. Install NPM packages

   npm install

3. Run server file

   cd server/

   python genome_browser_server.py

4. Run locally

   npm start

5. Build production version (Optional)

   npm run build

Use as a package

View Package

1. Download genome-browser package

   npm install genome-browser

2. Import into your project

   import { GenomeBrowserApp } from 'genome-browser';

3. Use the application as a component

   <div>
     <GenomeBrowserApp />
   </div>

4. 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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Le Binh - @lebinh1909 - [email protected]

Project Link: https://github.com/lebinh190998/porfolio