Logo

Genome Browser

Genome Browser is an interative tools to visualize and analyze genomic data.
View Demo · View Package . Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Use as a package
  4. Contributing
  5. Contact
## About The Project Cover Image Cover Image 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.

(back to top)

### Built With Frameworks/libraries used to bootstrap this project. - [React.js](https://reactjs.org/) - [Python](https://www.python.org/) - [C++](https://www.cplusplus.com/) - [HTML Canvas](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) - [MaterialUI](https://mui.com/)

(back to top)

## Getting Started To get a local copy up and running follow these simple example steps. ### Scripts 1. Clone the repo ```sh git clone https://github.com/lebinh190998/genome-browser.git ``` 2. Install NPM packages ```sh npm install ``` 3. Run server file ```sh cd server/ ``` ```sh python genome_browser_server.py ``` 4. Run locally ```sh npm start ``` 5. Build production version (Optional) ```sh npm run build ```

(back to top)

## Use as a package View Package 1. Download genome-browser package ```sh npm install genome-browser ``` 2. Import into your project ```js import { GenomeBrowserApp } from 'genome-browser'; ``` 3. Use the application as a component ```js
``` 4. Some useful props you can use a. Choose desired chromosome ```js ``` b. Choose desired human genome: 'hg38' or 'hg19' ```js ``` c. Host your own server with your genome data ```js ``` d. Choose your preferred starting and ending positions: ```js ```

(back to top)

## 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

(back to top)

## Contact Le Binh - [@lebinh1909](https://www.linkedin.com/in/binhle19/) - lebinh190998@gmail.com Project Link: [https://github.com/lebinh190998/porfolio](https://github.com/lebinh190998/genome-browser)

(back to top)