Skip to content

Latest commit

 

History

History
81 lines (58 loc) · 2.9 KB

README.md

File metadata and controls

81 lines (58 loc) · 2.9 KB

Snappy

Travis FOSSA Status

Screenshot

Snappy helps you browse through and interpret your genotype data, right on your browser. It accepts raw genotype files from 23andMe, AncestryDNA and FamilyTreeDNA. All processing is done on the browser, without sending sensitive data over the wire.

This is a prototype, and many things don't work right now. Expect crappy code and frequent crashes caused by high memory use. But you can help make it better!

If you haven't tested yet, SNPedia has a good outline of genetic testing services, including cost and SNP coverage. Snappy also has an option to use 23andMe's sample data if you'd like to play around.

Getting started

You need Yarn to install dependencies. Simply run yarn then yarn run dev to fire up the dev server. To build for production, run yarn run build.

npm will work, but it's not recommended. Cats love yarn, and you will love it, too.

(Optional) Download latest data from SNPedia

Snappy depends on data from SNPedia to work. A copy is included in the repo but may be out-of-date. To generate an updated copy, you need Python 3:

cd scripts
pip3 install -r < requirements.txt
make

The scripts will download and parse SNPedia, finally generating JSON files Snappy can consume. Copy those files to data.

Hacking

Snappy follows the Airbnb style guide with a few restrictions removed, as defined in .eslintrc.js. Most of the interesting stuff happen in src/snappy, which you can import elsewhere with import MyModule from '@/snappy/MyModule';. By the way, you are more than welcome to suggest large, breaking changes! Have fun :)

Licensing

Snappy is licensed under the BSD 2-Clause License. See LICENSE.md for details.

This project depends on certain third-party packages. Run yarn licenses ls to show their respective licenses.

This repository includes third-party materials. See THIRDPARTY.md for details.

Acknowledgments

Snappy is inspired by Promethease, GENOtation and other tools aiming to help people understand their genetic information.

This project would not be possible without: